Update one agent

The authenticated workspace is resolved from the target agent. For an attached Integration Action, send a connection tool attachment; the model sees only the resolved action name and input schema, never the Integration endpoint or signing secret.

patch/v1/agents/{agent_id}

Request

  • Base URL: https://api.skysay.ai
  • URL: https://api.skysay.ai/v1/agents/{agent_id}
  • Auth: none declared

Path parameters

agent_idstring required

Request body

audio_stream_urlstring
begin_messagestring
first_messagestring
languagestring
metadataobject

Replaces the agent's free-form metadata. The sections the voice-stack route owns are kept as stored when you leave them out, and a different value for one of them is refused with 400 naming PATCH /v1/agents/{agent_id}/voice-stack: follow_caller, opening and navigation (so a phone-menu navigation choice, including an explicit off, survives any metadata replacement).

mode'external_audio' | 'external_text' | 'hosted'
namestring
recording_enabledboolean
status'active' | 'inactive'

Whether this agent is offered to callers. inactive stops it being admitted on every call path -- inbound and outbound telephony, the browser test, and the public homepage demo -- while keeping the agent, its configuration and its number attachments intact; a call already in progress is not torn down. active removes that gate and nothing else: no configuration is snapshotted or restored, so the agent is then admitted on its CURRENT published configuration and readiness, which may have changed while it was inactive. Accepts these two values only; any other is refused with 400, as is any change to an agent whose stored status is not already one of them (an operator-suspended agent is reinstated by an operator only).

system_promptstring
webhook_urlstring

Response

Agent

Changes

No recorded changes to this operation across all 1 revision of this API.