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

# List Agents

> List all agents



## OpenAPI

````yaml get /api/v2/agents/list
openapi: 3.0.0
info:
  version: 1.0.0
  title: Octave API
  description: API for Octave workspace management and AI-powered content generation
servers:
  - url: https://app.octavehq.com
security:
  - ApiKeyAuth: []
paths:
  /api/v2/agents/list:
    get:
      tags:
        - Agents
      summary: List Agents
      description: List all agents
      operationId: listAgents
      parameters:
        - schema:
            type: string
            nullable: true
            enum:
              - PROSPECTOR
              - CONTENT
              - EMAIL
              - ENRICH_PERSON
              - ENRICH_COMPANY
              - QUALIFY_PERSON
              - QUALIFY_COMPANY
              - CALL_PREP
              - CONTEXT
            description: Type of the agent to list
          required: false
          name: type
          in: query
        - schema:
            type: string
            nullable: true
            default: ''
            description: Query for which agents to list
          required: false
          name: query
          in: query
        - schema:
            type: number
            nullable: true
            default: 0
            description: Offset of the agent to list
          required: false
          name: offset
          in: query
        - schema:
            type: number
            nullable: true
            default: 10
            description: Limit of the agent to list
          required: false
          name: limit
          in: query
        - schema:
            type: string
            enum:
              - createdAt
              - updatedAt
            default: createdAt
            description: Field to order the agents by
          required: false
          name: orderField
          in: query
        - schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
            description: Direction to order the agents by
          required: false
          name: orderDirection
          in: query
        - schema:
            type: boolean
            nullable: true
            default: false
            description: >-
              Whether to include experiments in the results. Only applies to
              EMAIL and CONTENT agent types. NOTE: when set to true, the
              response will be a list of agents and experiments so the total
              will be the sum of the agents and experiments and you may receive
              more items than the limit.
          required: false
          name: includeExperiments
          in: query
      responses:
        '200':
          description: List agents successful
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  hasNext:
                    type: boolean
                    description: Whether there are more results
                    example: false
                  total:
                    type: number
                    description: Total number of results
                    example: 0
                  data:
                    type: array
                    items:
                      anyOf:
                        - type: object
                          properties:
                            oId:
                              type: string
                              description: The OId of the item
                            name:
                              type: string
                              description: The name of the item
                            description:
                              type: string
                              description: The description of the item
                            createdAt:
                              type: string
                              nullable: true
                              description: The creation date of the item
                            updatedAt:
                              type: string
                              nullable: true
                              description: The last updated date of the item
                            type:
                              type: string
                              enum:
                                - PROSPECTOR
                                - CONTENT
                                - EMAIL
                                - ENRICH_PERSON
                                - ENRICH_COMPANY
                                - QUALIFY_PERSON
                                - QUALIFY_COMPANY
                                - CALL_PREP
                                - CONTEXT
                              description: The type of the agent
                            costToRun:
                              type: number
                              description: The cost to run the item
                            steps:
                              type: number
                              description: >-
                                The number of steps in the agent. Only available
                                for email agents.
                            itemType:
                              type: string
                              enum:
                                - agent
                              description: >-
                                Indicates this is an individual agent (only
                                present when includeExperiments=true)
                            contentOutputFormat:
                              type: string
                              enum:
                                - JSON
                                - TEXT
                                - HTML
                                - MARKDOWN
                              description: >-
                                The output format of the Agent (only available
                                for CONTENT agents)
                          required:
                            - oId
                            - name
                            - description
                            - createdAt
                            - updatedAt
                            - type
                        - type: object
                          properties:
                            oId:
                              type: string
                              description: The OId of the item
                            name:
                              type: string
                              description: The name of the item
                            description:
                              type: string
                              description: The description of the item
                            createdAt:
                              type: string
                              nullable: true
                              description: The creation date of the item
                            updatedAt:
                              type: string
                              nullable: true
                              description: The last updated date of the item
                            type:
                              type: string
                              enum:
                                - PROSPECTOR
                                - CONTENT
                                - EMAIL
                                - ENRICH_PERSON
                                - ENRICH_COMPANY
                                - QUALIFY_PERSON
                                - QUALIFY_COMPANY
                                - CALL_PREP
                                - CONTEXT
                              description: The type of the agent
                            costToRun:
                              type: number
                              description: The cost to run the item
                            steps:
                              type: number
                              description: >-
                                The number of steps in the agent. Only available
                                for email agents.
                            itemType:
                              type: string
                              enum:
                                - experiment
                              description: >-
                                Indicates this is an experiment containing
                                multiple agents
                            runStrategy:
                              type: string
                              nullable: true
                              enum:
                                - RANDOM
                                - ROUND_ROBIN
                                - WEIGHTED
                              description: The run strategy for the experiment
                          required:
                            - oId
                            - name
                            - description
                            - createdAt
                            - updatedAt
                            - type
                            - itemType
                required:
                  - _metadata
                  - hasNext
                  - total
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
      deprecated: false
components:
  schemas:
    Metadata:
      type: object
      properties:
        usage:
          type: number
          default: 0
          description: API usage
          example: 0
        requestId:
          type: string
          description: Request ID
          example: requestId
        message:
          type: string
          description: Message
          example: message
        timestamp:
          type: string
          description: Timestamp
          example: '2021-01-01T00:00:00.000Z'
      required:
        - requestId
        - timestamp
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: api_key

````