> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fish.audio/llms.txt
> Use this file to discover all available pages before exploring further.

# List Agents

> List your team's agents, newest first.



## OpenAPI

````yaml get /v1/agent/agents
openapi: 3.1.0
info:
  title: FishAudio OpenAPI
  version: '1'
servers:
  - description: Fish Audio API
    url: https://api.fish.audio
security: []
tags: []
paths:
  /v1/agent/agents:
    get:
      tags:
        - Agents
      summary: List Agents
      description: |-
        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.
      parameters:
        - in: query
          name: search
          description: Case-insensitive match on name and description.
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
            title: Search
          deprecated: false
        - in: query
          name: include_archived
          description: ''
          required: false
          schema:
            default: false
            title: Include Archived
            type: boolean
          deprecated: false
        - in: query
          name: publication_state
          description: '`live` = has a published version; `draft` = never published.'
          required: false
          schema:
            default: all
            enum:
              - all
              - live
              - draft
            title: Publication State
            type: string
          deprecated: false
        - in: query
          name: cursor
          description: ''
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            default: null
            title: Cursor
          deprecated: false
        - in: query
          name: page
          description: >-
            1-based page number (offset pagination). Returns total; mutually
            exclusive with cursor.
          required: false
          schema:
            anyOf:
              - minimum: 1
                type: integer
              - type: 'null'
            default: null
            title: Page
          deprecated: false
        - in: query
          name: include_total
          description: Also count the filtered set on the cursor path.
          required: false
          schema:
            default: false
            title: Include Total
            type: boolean
          deprecated: false
        - in: query
          name: page_size
          description: ''
          required: false
          schema:
            default: 30
            maximum: 100
            minimum: 1
            title: Page Size
            type: integer
          deprecated: false
      responses:
        '200':
          description: Request fulfilled, document follows
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  agents:
                    items:
                      $ref: '#/components/schemas/PublicAgentEntity'
                    title: Agents
                    type: array
                  has_more:
                    title: Has More
                    type: boolean
                  next_cursor:
                    anyOf:
                      - type: string
                      - type: 'null'
                    default: null
                    title: Next Cursor
                  total:
                    anyOf:
                      - type: integer
                      - type: 'null'
                    default: null
                    title: Total
                required:
                  - agents
                  - has_more
                type: object
        '400':
          description: Bad request syntax or unsupported method
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                required:
                  - status
                  - message
                type: object
        '401':
          description: No permission -- see authorization schemes
          headers: {}
          content:
            application/json:
              schema:
                properties:
                  status:
                    title: Status
                    type: integer
                  message:
                    title: Message
                    type: string
                required:
                  - status
                  - message
                type: object
      security:
        - BearerAuth: []
components:
  schemas:
    PublicAgentEntity:
      properties:
        agent_id:
          title: Agent Id
          type: string
        workspace_id:
          title: Workspace Id
          type: string
        name:
          title: Name
          type: string
        description:
          default: ''
          title: Description
          type: string
        status:
          enum:
            - active
            - archived
          title: Status
          type: string
        publication_state:
          description: >-
            `live` once at least one version is published; `draft` agents cannot
            take sessions yet.
          enum:
            - live
            - draft
          title: Publication State
          type: string
        public_enabled:
          default: false
          title: Public Enabled
          type: boolean
        allowed_origins:
          items:
            type: string
          title: Allowed Origins
          type: array
        overrides_allowed:
          items:
            enum:
              - first_message
              - system_prompt
              - voice_id
              - language
            type: string
          title: Overrides Allowed
          type: array
        created_at:
          format: date-time
          title: Created At
          type: string
        updated_at:
          format: date-time
          title: Updated At
          type: string
      required:
        - agent_id
        - workspace_id
        - name
        - status
        - publication_state
        - created_at
        - updated_at
      title: PublicAgentEntity
      type: object
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````