FIfish
Agents

List Agents

Changed on

List your team's agents, newest first. Paginate with cursor (follow next_cursor while has_more is true) or with page for offset pagination with a total count — the two are mutually exclusive.

get/v1/agent/agents

Request

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

Query parameters

searchstring nullable

Case-insensitive match on name and description.

include_archivedboolean
publication_state'all' | 'live' | 'draft'

live = has a published version; draft = never published.

cursorstring nullable
pageinteger nullable

1-based page number (offset pagination). Returns total; mutually exclusive with cursor.

include_totalboolean

Also count the filtered set on the cursor path.

page_sizeinteger

Response

Request fulfilled, document follows

has_moreboolean required
next_cursorstring nullable
totalinteger nullable

Changes