Get an agent | RubricHQ Docs

{
  "id": 1,
  "client_id": 1,
  "name": "string",
  "phone_number": "string",
  "conversation_type": "inbound",
  "integration_type": "string",
  "agent_kind": "string",
  "language_id": 1,
  "instructions": "string",
  "first_message": {},
  "max_call_duration": 1,
  "web_call_url": "string",
  "integration_config": {},
  "phone_channel": {},
  "web_channel": {},
  "text_channel": {},
  "disabled_standard_metrics": [
    "string"
  ],
  "disabled_llm_metric_ids": [
    1
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "updated_at": "2024-01-15T09:30:00Z",
  "links": {
    "self": "string",
    "scenarios": "string"
  }
}

Authentication

AuthorizationBearer

JWT token from RubricHQ Settings → API Keys

Path parameters

idintegerRequired

Internal agent ID.

Query parameters

client_idintegerRequired

Required. RubricHQ client (workspace) ID that owns this agent.

Response

Agent details

idinteger

client_idinteger

namestring

phone_numberstring or null

conversation_typeenum

integration_typestring

agent_kindstring

language_idinteger or null

instructionsstring or null

first_messageobject or null

max_call_durationinteger or null

web_call_urlstring or null

integration_configobject or null

phone_channelobject or null

web_channelobject or null

text_channelobject or null

disabled_standard_metricslist of strings

disabled_llm_metric_idslist of integers

created_atdatetime

updated_atdatetime

linksobject

Errors

404

Not Found Error

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