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

# List agents



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/cerca/openapi.documented.yml get /agents
openapi: 3.1.0
info:
  description: API-key accessible routes for Cerca agents.
  title: Cerca API
  version: 0.0.0
servers:
  - url: https://api.cerca.dev
security:
  - bearerAuth: []
paths:
  /agents:
    get:
      tags:
        - Agents
      summary: List agents
      parameters:
        - schema:
            type: string
            enum:
              - 'true'
              - 'false'
            description: >-
              When set to true, lists only agents with active or awaiting
              threads.
            example: 'true'
          required: false
          description: When set to true, lists only agents with active or awaiting threads.
          name: active
          in: query
        - schema:
            type: string
            description: Opaque pagination cursor returned by a previous request.
            example: cursor_abc123
          required: false
          description: Opaque pagination cursor returned by a previous request.
          name: cursor
          in: query
        - schema:
            type: string
            description: >-
              Fleet to list agents from. Defaults to the API key's default fleet
              when omitted.
            example: fleet_abc123
          required: false
          description: >-
            Fleet to list agents from. Defaults to the API key's default fleet
            when omitted.
          name: fleetId
          in: query
        - schema:
            type: string
            description: >-
              Maximum number of items to return. Defaults to 20 and preserves
              parseInt semantics.
            example: '20'
          required: false
          description: >-
            Maximum number of items to return. Defaults to 20 and preserves
            parseInt semantics.
          name: limit
          in: query
      responses:
        '200':
          description: Agents page.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentsPage'
        '400':
          description: Invalid runtime request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Authentication required.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: >-
            Access denied or non-transient quota exceeded. Limit errors include
            a stable code field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Runtime resource not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: >-
            Transient capacity limit exceeded. Limit errors include a stable
            code field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Required runtime dependency unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        default:
          description: Runtime error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Cerca from '@cerca-dev/sdk';

            const client = new Cerca({
              apiKey: process.env['CERCA_API_KEY'], // This is the default and can be omitted
            });

            // Automatically fetches more pages as needed.
            for await (const agentSummary of client.agents.list()) {
              console.log(agentSummary.id);
            }
        - lang: Python
          source: |-
            import os
            from cerca import Cerca

            client = Cerca(
                api_key=os.environ.get("CERCA_API_KEY"),  # This is the default and can be omitted
            )
            page = client.agents.list()
            page = page.agents[0]
            print(page.id)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/matrices/cerca-go\"\n\t\"github.com/matrices/cerca-go/option\"\n)\n\nfunc main() {\n\tclient := cercago.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tpage, err := client.Agents.List(context.TODO(), cercago.AgentListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", page)\n}\n"
        - lang: Ruby
          source: |-
            require "cerca"

            cerca = Cerca::Client.new(api_key: "My API Key")

            page = cerca.agents.list

            puts(page)
        - lang: CLI
          source: |-
            cerca agents list \
              --api-key 'My API Key'
components:
  schemas:
    AgentsPage:
      type: object
      properties:
        agents:
          type: array
          items:
            $ref: '#/components/schemas/AgentSummary'
        cursor:
          type:
            - string
            - 'null'
        hasMore:
          type: boolean
      required:
        - agents
        - cursor
        - hasMore
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: Stable machine-readable error code when the API can provide one.
          example: MONTHLY_TOKEN_BUDGET_EXCEEDED
      required:
        - error
    AgentSummary:
      type: object
      properties:
        activeThreadCount:
          type: number
        awaitingThreadCount:
          type: number
        createdAt:
          type: string
        defaultModel:
          type:
            - string
            - 'null'
        fleetId:
          type: string
        id:
          type: string
        metadata:
          $ref: '#/components/schemas/AgentMetadata'
        orgId:
          type: string
        updatedAt:
          type: string
        userId:
          type: string
      required:
        - activeThreadCount
        - awaitingThreadCount
        - createdAt
        - defaultModel
        - fleetId
        - id
        - metadata
        - orgId
        - updatedAt
        - userId
    AgentMetadata:
      type: object
      additionalProperties:
        type: string
      description: >-
        Arbitrary string metadata stored on an agent. Runtime enforces maximum
        key and value sizes.
      example:
        project: alpha
  securitySchemes:
    bearerAuth:
      bearerFormat: Cerca API key
      scheme: bearer
      type: http

````