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

# Get Agent

> Fetch an agent details



## OpenAPI

````yaml get /api/v2/agent/{agentId}
openapi: 3.0.0
info:
  version: 2.0.0
  title: Vida API
  description: Vida API Documentation
servers:
  - url: https://api.vida.dev
    description: Vida Production
    variables:
      baseUrl:
        default: api.vida.dev
        description: Production API Root
security: []
paths:
  /api/v2/agent/{agentId}:
    get:
      tags:
        - Agents
      summary: Get Agent
      description: Fetch an agent details
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
          description: Agent Id
          example: campa931829b5857f....
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: Success
                  campaign:
                    description: >-
                      Full agent configuration for the requested campaign id.
                      Additional fields may be present beyond those documented
                      here.
                    properties:
                      id:
                        description: Agent Id
                        type: string
                        example: campa931829b5857f....
                      title:
                        description: Agent title.
                        type: string
                        example: Front Desk Operator
                      campaignType:
                        description: Agent type.
                        type: string
                        example: chatAgent
                      enabled:
                        description: Whether the agent is enabled.
                        type: boolean
                        example: true
                      published:
                        description: Whether this campaign is currently published.
                        type: boolean
                        example: true
                      welcomeMessage:
                        description: Initial greeting or welcome message.
                        type: string
                        example: Hello, thanks for calling. How can I help you today?
                      timezone:
                        description: IANA timezone for agent runtime behavior.
                        type: string
                        example: America/Chicago
                      agentVoice:
                        description: Configured voice model.
                        type: string
                        example: cedar
                      agentLang:
                        description: Language for voice and transcription flows.
                        type: string
                        example: multi
                      agentModel:
                        description: Primary LLM model.
                        type: string
                        example: gpt-5.4
                      agentThinking:
                        description: Optional reasoning budget.
                        type: string
                        nullable: true
                        example: null
                      agentInstructions:
                        description: General agent instructions.
                        type: string
                        example: >-
                          Answer as the front desk operator and book
                          appointments when appropriate.
                      publicInstructions:
                        description: >-
                          Additional instructions used only in public-facing
                          conversations with your agent.
                        type: string
                        example: >-
                          Keep public-channel replies concise and ask clarifying
                          questions one at a time.
                      adminInstructions:
                        description: >-
                          Admin instructions written into the managed AGENTS.md
                          admin section on publish.
                        type: string
                        example: >-
                          Report missed-call spikes and urgent customer
                          escalations to your boss.
                      heartbeatInstructions:
                        description: >-
                          Heartbeat instructions written into the managed
                          HEARTBEAT.md section on publish.
                        type: string
                        example: Check for overdue callbacks on every heartbeat.
                      heartbeatEvery:
                        description: >-
                          Heartbeat interval override saved on the campaign and
                          synced into published agent runtime config only when
                          changed on publish.
                        type: string
                        example: 15m
                      links:
                        description: External knowledge links configured for this agent.
                        type: array
                        items:
                          type: string
                          example: https://vida.io/faq
                      activeEventRules:
                        description: Currently active event-rule slots for this campaign.
                        type: array
                        items:
                          type: string
                          example: default
                      actions:
                        description: >-
                          Configured agent actions. Returned actions may be
                          enriched with capability metadata for the requesting
                          owner.
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                              example: transfer
                            instructions:
                              type: string
                              example: Transfer important calls directly to the owner.
                            placeholder:
                              type: string
                              example: >-
                                When should your agent route calls and
                                conversations to you?
                            allowed:
                              type: boolean
                              example: true
                      skills:
                        description: Declarative skill configuration for this agent.
                        type: array
                        items:
                          type: object
                          properties:
                            slug:
                              type: string
                              example: google-drive
                            instructions:
                              type: string
                              example: Use this for customer spreadsheet review.
                            allowed:
                              type: boolean
                              example: true
                            usable:
                              type: boolean
                              example: false
                            reason:
                              type: string
                              nullable: true
                              example: not_installed
                      apps:
                        description: Configured app integrations for this agent.
                        type: array
                        items:
                          type: object
                      lastUpdate:
                        description: Unix-ms timestamp of the most recent update.
                        type: integer
                        example: 1776634844766
      security:
        - apiKeyAuth: []
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: query
      name: token
      description: Vida API Token

````