FIfish
Agents

Get Agent

Changed on

Fetch one agent's profile fields. The draft configuration lives at GET /v1/agent/agents/{agent_id}/config.

get/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

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