Skip to navigation
Agents

Get an agent

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired
Internal agent ID.

Query parameters

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.

Response

Agent details
idintegerOptional
client_idintegerOptional
namestringOptional
agent_sourceenumOptional

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

Allowed values:
phone_numberstring or nullOptional
conversation_typeenumOptional
Allowed values:
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
interruption_threshold_msinteger or nullOptional
transport_layer_web_callingenum or nullOptional

Web-calling transport, or null for phone-only agents. Same value as web_channel.transport.

Allowed values:
web_channelobjectOptional

The agent’s web channel as stored, or null for a phone-only agent. Only the fields for the active transport are present. Credentials are never echoed: each key/secret is reported as a <name>_set boolean.

telephony_carrierstring or nullOptional

Read-only. The carrier RubricHQ dials this agent over, derived from the country code of phone_number.

disabled_metric_idslist of integersOptional

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

created_atdatetimeOptional
updated_atdatetimeOptional

Errors

404
Not Found Error