Core - Retrieve external agent
curl --get 'https://my.orq.ai/v2/agents/external/support_agent' \
--header "Authorization: Bearer $ORQ_API_KEY"
import { Orq } from '@orq-ai/node';
const client = new Orq({
apiKey: process.env.ORQ_API_KEY,
});
const result = await client.agents.external.retrieve({
agentKey: 'support_agent',
});
console.log(result.agent.displayName, result.agent.cardRefreshedAt);
import os
from orq_ai_sdk import Orq
client = Orq(api_key=os.environ["ORQ_API_KEY"])
result = client.agents.external.retrieve(
agent_key="support_agent",
)
print(result.agent.display_name, result.agent.card_refreshed_at)
{
"agent": {
"agent_id": "<string>",
"key": "<string>",
"display_name": "<string>",
"description": "<string>",
"path": "<string>",
"project_id": "<string>",
"agent_url": "<string>",
"headers": {},
"protocol_version": "<string>",
"preferred_transport": "<string>",
"cached_card": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"version": "<string>",
"card_url": "<string>",
"card_refreshed_at": "2023-11-07T05:31:56Z"
}
}External Agents
Retrieve external agent
Retrieves a registered external A2A agent by key or ID. Encrypted header values are always masked.
GET
/
v2
/
agents
/
external
/
{agent_key}
Core - Retrieve external agent
curl --get 'https://my.orq.ai/v2/agents/external/support_agent' \
--header "Authorization: Bearer $ORQ_API_KEY"
import { Orq } from '@orq-ai/node';
const client = new Orq({
apiKey: process.env.ORQ_API_KEY,
});
const result = await client.agents.external.retrieve({
agentKey: 'support_agent',
});
console.log(result.agent.displayName, result.agent.cardRefreshedAt);
import os
from orq_ai_sdk import Orq
client = Orq(api_key=os.environ["ORQ_API_KEY"])
result = client.agents.external.retrieve(
agent_key="support_agent",
)
print(result.agent.display_name, result.agent.card_refreshed_at)
{
"agent": {
"agent_id": "<string>",
"key": "<string>",
"display_name": "<string>",
"description": "<string>",
"path": "<string>",
"project_id": "<string>",
"agent_url": "<string>",
"headers": {},
"protocol_version": "<string>",
"preferred_transport": "<string>",
"cached_card": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by_id": "<string>",
"updated_by_id": "<string>",
"version": "<string>",
"card_url": "<string>",
"card_refreshed_at": "2023-11-07T05:31:56Z"
}
}Was this page helpful?