FIfish
Agents

Update Agent

Changed on

Update agent-level fields (name, description, status, public access and session-override policy). Omitted fields keep their value. Conversation behavior — voice, prompt, recording and the rest — is draft configuration: use PATCH /v1/agent/agents/{agent_id}/config.

patch/v1/agent/agents/{agent_id}

Request

  • Base URL
    https://api.fish.audio
  • URL
    https://api.fish.audio/v1/agent/agents/{agent_id}
  • Auth
    HTTP bearer

Path parameters

agent_idstring required

Request body

namestring nullable
descriptionstring nullable
status'active' | 'archived' nullable
public_enabledboolean nullable

Allow keyless session creation from the browser SDK, gated by allowed_origins.

allowed_originsstring[] nullable
overrides_allowedstring[] nullable

Which session-creation overrides callers may use. An empty list rejects all overrides.

Response

Request fulfilled, document follows

agent_idstring required
workspace_idstring required
namestring required
descriptionstring
status'active' | 'archived' required
publication_state'live' | 'draft' required

live once at least one version is published; draft agents cannot take sessions yet.

public_enabledboolean
allowed_originsstring[]
overrides_allowedstring[]
created_atstring date-time required
updated_atstring date-time required

Changes