> ## 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.

# Get Agent

> Get Agent by OId



## OpenAPI

````yaml get /api/v2/agents/get
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/get:
    get:
      tags:
        - Agents
      summary: Get Agent
      description: Get Agent by OId
      operationId: getAgent
      parameters:
        - schema:
            type: string
            description: Agent OId
          required: true
          name: oId
          in: query
      responses:
        '200':
          description: Agent data
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  data:
                    type: object
                    properties:
                      oId:
                        type: string
                        description: The OId of the agent
                      name:
                        type: string
                        description: The name of the agent
                      description:
                        type: string
                        description: The description of the agent
                      type:
                        type: string
                        enum:
                          - PROSPECTOR
                          - CONTENT
                          - EMAIL
                          - ENRICH_PERSON
                          - ENRICH_COMPANY
                          - QUALIFY_PERSON
                          - QUALIFY_COMPANY
                          - CALL_PREP
                          - CONTEXT
                        description: The type of the agent
                      data:
                        nullable: true
                        description: The full agent configuration data
                      createdAt:
                        type: string
                        nullable: true
                        description: The creation date of the agent
                      updatedAt:
                        type: string
                        nullable: true
                        description: The last updated date of the agent
                      costToRun:
                        type: number
                        description: The cost to run the agent
                      warnings:
                        type: array
                        items:
                          type: string
                        description: >-
                          Warnings about type-mismatched fields that were
                          provided but ignored
                    required:
                      - oId
                      - name
                      - description
                      - type
                      - createdAt
                      - updatedAt
                      - costToRun
                required:
                  - _metadata
                  - data
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                type: object
                properties:
                  _metadata:
                    $ref: '#/components/schemas/Metadata'
                  message:
                    type: string
                required:
                  - _metadata
                  - message
        '404':
          description: Agent not found
          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

````