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

# Get Assistant By ID

> Retrieves detailed information about a specific assistant by its ID.

Fetch details for one assistant. Use this after an operator selects an assistant or when debugging why a call did not behave as expected.

## Useful checks

* Confirm the assistant exists in the current workspace.
* Inspect call direction, prompt configuration, variables, and assigned resources.
* Verify the assistant is the one your integration intended to use.

## Related endpoints

* [List assistants](/api-reference/endpoint/assistant/get-assistants)
* [Initiate individual call](/api-reference/endpoint/calling/initiate-individual-call)
* [Upload campaign contact list](/api-reference/endpoint/campaign/upload-campaign-contact-list)


## OpenAPI

````yaml get /agent/{agent_id}
openapi: 3.0.0
info:
  title: Ringg AI API Documentation
  description: >-
    This is the documentation for the Ringg AI APIs. The Ringg AI API follows
    RESTful principles, making it intuitive and easy to integrate with your
    applications. All API requests should be made to the base URL. The API
    accepts and returns data in JSON format. Ensure your requests include the
    appropriate Content-Type header for POST and PATCH requests.
  version: 2.0.0
servers:
  - url: https://prod-api.ringg.ai/ca/api/v0
security: []
tags:
  - name: workspace
    description: Endpoints for managing your workspace.
  - name: agent
    description: Endpoints for managing assistants (agents).
  - name: calling
    description: Endpoints for making and managing calls.
  - name: campaign
    description: Endpoints for managing campaigns.
  - name: analytics
    description: Endpoints for accessing call analytics and performance metrics.
  - name: termination
    description: Endpoints for terminating active calls using different methods.
  - name: knowledgebase
    description: Endpoints for managing knowledge bases.
paths:
  /agent/{agent_id}:
    get:
      tags:
        - agent
      summary: Get Assistant By ID
      description: Retrieves detailed information about a specific assistant by its ID.
      operationId: getAssistantById
      parameters:
        - name: X-API-KEY
          in: header
          description: (Required) Your Ringg AI API key.
          required: true
          schema:
            type: string
            example: 7251cb4b-3373-43a4-844c-b27a1d45e0c9
        - name: agent_id
          in: path
          description: (Required) ID of the assistant to retrieve.
          required: true
          schema:
            type: string
            example: 830f767a-397e-4b39-82ff-235cd344e2f9
      responses:
        '200':
          description: 'Successful Response: Detailed information about the assistant.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  agents:
                    type: object
                    properties:
                      id:
                        type: string
                        example: 830f767a-397e-4b39-82ff-235cd344e2f9
                      agent_display_name:
                        type: string
                        example: Sales Assistant
                      agent_type:
                        type: string
                        example: outbound
                      whitelisted_domains:
                        type: array
                        items:
                          type: string
                        example:
                          - https://www.ringg.ai
                          - https://example.com
                      language:
                        type: string
                        example: en-US
                      form_fields:
                        type: array
                        items:
                          type: object
                          properties:
                            key:
                              type: string
                            value:
                              type: string
                        example:
                          - key: company_name
                            value: Ringg AI
                          - key: product
                            value: AI calling platform
                      voice:
                        type: object
                        properties:
                          id:
                            type: string
                            example: 3b5c7d2a-8e9f-4a1b-9c6d-2e5f8a7b3c4d
                          name:
                            type: string
                            example: Sarah
                          voice_preview:
                            type: string
                            format: uri
                            example: https://example.com/voice-preview.mp3
                      agent_config:
                        type: object
                        example:
                          custom_variables:
                            callee_name: string
                            mobile_number: string
                          agent_prompt: You are a helpful sales assistant.
                          intro_message: Hello! I'm calling from Ringg AI.
                      knowledge_base_id:
                        type: string
                        nullable: true
                        example: 7a9c2d5e-4f6b-1a2b-3c4d-5e6f7a8b9c0d
                      knowledge_base_name:
                        type: string
                        nullable: true
                        example: Product FAQ
                      template_name:
                        type: string
                        example: sales
                      template_label:
                        type: string
                        example: Sales Agent
                      template_icon:
                        type: string
                        example: 💼
                      created_at:
                        type: string
                        format: date-time
                        example: '2024-12-16T13:03:29.947147+00:00'
                      updated_at:
                        type: string
                        format: date-time
                        example: '2024-12-16T14:15:32.123456+00:00'
                      tools:
                        type: array
                        items:
                          type: object
                          properties:
                            name:
                              type: string
                            config:
                              type: object
                            tool_type:
                              type: string
                        example: []
                      secondary_language:
                        type: string
                        nullable: true
                        example: hi-IN
                      secondary_voice_id:
                        type: string
                        nullable: true
                        example: 4c6d8e3b-9f0a-5b2c-ad7e-3f6a9b8c5d7e
                      template_type:
                        type: string
                        example: outbound
        '401':
          description: Unauthorized - Invalid or missing API key.
        '404':
          description: Not Found - Resource doesn't exist.
        '500':
          description: Internal Server Error - Something went wrong on our end.

````