Get an agent | RubricHQ Docs

AuthorizationBearer

API key from RubricHQ Settings → API Keys. Send it as: Authorization: Bearer <YOUR_API_KEY>.

idintegerRequired

Internal agent ID.

client_idintegerOptional

Optional. RubricHQ client (workspace) ID. Defaults to the workspace your API key belongs to; pass it only to target another workspace you can access.

Agent details

idintegerOptional

client_idintegerOptional

namestringOptional

agent_sourceenumOptional

Where the agent comes from (see CreateAgentRequest.agent_source).

phone_numberstring or nullOptional

conversation_typeenumOptional

language_idinteger or nullOptional

instructionsstring or nullOptional

opening_messageobject or nullOptional

The agent’s opening-message configuration (see CreateAgentRequest.opening_message).

max_call_durationinteger or nullOptional

transport_layer_web_callingenum or nullOptional

Web-calling transport, or null for phone-only agents.

disabled_metric_idslist of integersOptional

Metric IDs currently disabled for this agent (built-in + custom, unified).

created_atdatetimeOptional

updated_atdatetimeOptional

linksobjectOptional

404

Not Found Error

1	{
2	"id": 1,
3	"client_id": 1,
4	"name": "string",
5	"agent_source": "internal",
6	"phone_number": "string",
7	"conversation_type": "inbound",
8	"language_id": 1,
9	"instructions": "string",
10	"opening_message": {},
11	"max_call_duration": 1,
12	"transport_layer_web_calling": "livekit",
13	"disabled_metric_ids": [
14	1
15	],
16	"created_at": "2024-01-15T09:30:00Z",
17	"updated_at": "2024-01-15T09:30:00Z",
18	"links": {
19	"self": "string",
20	"scenarios": "string"
21	}
22	}

$	curl https://api.rubrichq.io/api/public/v1/agents/1 \
>	-H "Authorization: Bearer <token>"