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

# Get an agent



## OpenAPI

````yaml openapi.json GET /v1/agents/{agentId}
openapi: 3.1.0
info:
  title: Egma Platform API
  version: 1.0.0
  description: >-
    The customer-facing HTTP interface used by Egma's web app, CLI, and outside
    clients.
servers:
  - url: https://app.egma.ai
security: []
paths:
  /v1/agents/{agentId}:
    get:
      tags:
        - Agents
      summary: Get an agent
      operationId: getAgent
      parameters:
        - name: agentId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
            description: The Egma agent ID returned by Register an agent or List agents.
            examples:
              - agt_01M0E4J0BBE1FVDVTZ1BSS5C97
        - name: projectId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
        - name: archived
          in: query
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: The agent and the requested set of connections.
          content:
            application/json:
              schema:
                type: object
                properties:
                  agent:
                    type: object
                    properties:
                      id:
                        type: string
                        minLength: 1
                      projectId:
                        type: string
                        minLength: 1
                      name:
                        type: string
                      agentPlatform:
                        type: string
                        enum:
                          - retell
                          - livekit
                      platformAgentId:
                        anyOf:
                          - type: string
                          - type: 'null'
                      retellModality:
                        anyOf:
                          - type: string
                            enum:
                              - voice
                              - chat
                          - type: 'null'
                      monitoringKeyPresent:
                        type: boolean
                      monitoringApiKeyHint:
                        anyOf:
                          - type: string
                          - type: 'null'
                      pullProductionCalls:
                        type: boolean
                      monitoringConfigured:
                        type: boolean
                      lastReceivedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                      archived:
                        type: boolean
                      archivedAt:
                        anyOf:
                          - type: string
                            format: date-time
                          - type: 'null'
                      createdAt:
                        type: string
                        format: date-time
                      updatedAt:
                        type: string
                        format: date-time
                    required:
                      - id
                      - projectId
                      - name
                      - agentPlatform
                      - platformAgentId
                      - retellModality
                      - monitoringKeyPresent
                      - monitoringApiKeyHint
                      - pullProductionCalls
                      - monitoringConfigured
                      - lastReceivedAt
                      - archived
                      - archivedAt
                      - createdAt
                      - updatedAt
                    additionalProperties: false
                  connections:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          minLength: 1
                        agentId:
                          type: string
                          minLength: 1
                        projectId:
                          type: string
                          minLength: 1
                        name:
                          type: string
                        agentPlatform:
                          type: string
                          enum:
                            - retell
                            - livekit
                        connectionType:
                          type: string
                          enum:
                            - retell_chat_api
                            - retell_text_mode
                            - retell_web_call
                            - phone_number
                            - livekit_room
                        accessVariant:
                          type: string
                          enum:
                            - retell_chat_api.api_key
                            - retell_text_mode.api_key
                            - retell_web_call.api_key
                            - phone_number.public_e164
                            - livekit_room.project_credentials
                            - livekit_room.customer_token_endpoint
                        modality:
                          type: string
                          enum:
                            - voice
                            - chat
                        productLabel:
                          type: string
                        topology:
                          type: string
                          enum:
                            - agent-dials-out
                            - hosted-broker
                            - egma-dials-in
                        environment:
                          anyOf:
                            - type: string
                            - type: 'null'
                        config:
                          type: object
                          additionalProperties:
                            type: string
                        credentialPresent:
                          type: boolean
                        credentialsHint:
                          anyOf:
                            - type: string
                            - type: 'null'
                        archived:
                          type: boolean
                        archivedAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                        createdAt:
                          type: string
                          format: date-time
                        updatedAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - agentId
                        - projectId
                        - name
                        - agentPlatform
                        - connectionType
                        - accessVariant
                        - modality
                        - productLabel
                        - topology
                        - environment
                        - config
                        - credentialPresent
                        - credentialsHint
                        - archived
                        - archivedAt
                        - createdAt
                        - updatedAt
                      additionalProperties: false
                required:
                  - agent
                  - connections
                additionalProperties: false
        '400':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '401':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '403':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '404':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '429':
          description: The request rate limit was reached.
          headers:
            Retry-After:
              description: Seconds to wait before trying again.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Refusal:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
      required:
        - error
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Egma API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: egma.session_token
      description: >-
        The browser session cookie issued by Egma. HTTPS deployments add the
        standard __Secure- prefix.

````