Agents

Update an agent

Authentication

AuthorizationBearer

JWT token from RubricHQ Settings → API Keys

Path parameters

idintegerRequired

Query parameters

client_idintegerRequired

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

Request

This endpoint expects an object.
namestringRequired

Human-readable agent name (shown in dashboard).

client_idintegerRequired

Required. Client (workspace) to create the agent under.

phone_numberstringOptional

E.164 phone number used by the agent for outbound or inbound calls. Required for non-external integration_types.

conversation_typeenumOptionalDefaults to inbound

Call direction(s) this agent supports.

integration_typeenumOptionalDefaults to pipecat_twilio

Transport / orchestration stack used to run the agent. external_vapi and external_retell delegate to third-party services — you must also provide integration_config.assistant_id.

agent_kindenumOptionalDefaults to internal
language_idintegerOptional

Language pack ID. Required for non-external integrations.

instructionsstringOptional

System prompt / behavioral instructions for the agent LLM. Required for non-external integrations.

first_messageobjectOptional
The agent's opening utterance configuration.
max_call_durationintegerOptional10-3600

Hard cap on call length, in seconds. Runtime force-hangs up after this.

web_call_urlstringOptionalformat: "uri"

Legacy LiveKit room URL (only for integration_type=pipecat_livekit).

twilio_phone_numberstringOptional

Twilio-provisioned phone number (when using pipecat_twilio).

interruption_threshold_msintegerOptional
Milliseconds of caller speech that should trigger an interruption event.
integration_configmap from strings to anyOptional

Integration-specific config blob. Shape depends on integration_type:

  • external_vapi / external_retell: { assistant_id: "asst_xxx" }
  • pipecat_twilio: reserved for future provider overrides
phone_channelmap from strings to anyOptional

Channel config for phone — { provider, config: { ... } }.

web_channelmap from strings to anyOptional

Channel config for web — { provider, config: { ... } }.

text_channelmap from strings to anyOptional

Channel config for text — { provider, config: { ... } }.

disabled_llm_metric_idslist of integersOptional
LLM metric IDs to skip evaluation for on this agent.

Response

Updated agent
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

Errors

422
Unprocessable Entity Error