> ## 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. > ## Agent Instructions > To search or read these docs, connect the Ringg docs MCP server at https://docs.ringg.ai/mcp (no key needed; tools search_ringg_ai and query_docs_filesystem_ringg_ai) instead of browsing pages one by one. Setup for each client: https://docs.ringg.ai/resources/mcp-server/docs-mcp-server/mcp-for-ai-assistants.md > The dashboard labels agents "Assistants"; these docs say "agent". Both mean the same object, identified by agent_id. > API base URL: https://prod-api.ringg.ai/ca/api/v0. Send the workspace API key in the X-API-KEY header, from server-side code only. > Placing a call dials a real phone number and spends credits. Confirm the number with the user before calling. > To act on a Ringg workspace (place calls, edit agents, read transcripts), use the separate Ringg workspace MCP server at https://mcp.ringg.ai/mcp: https://docs.ringg.ai/resources/mcp-server/workspace-mcp-server/overview.md > Get one agent's configuration by its agent_id to confirm the agent exists in this workspace and check its name, type and settings before you call with it. # Get Agent export const RelatedTopics = ({items}) =>
Related topics
{items.map(([title, href]) => {title} )}
; The agent is returned under `agents` as an object. Agent-level fields, such as `agent_display_name`, `agent_type` and `active_agent_version_id`, sit at the top; each version's language, voice, prompt (`agent_config`), tools, knowledge bases, `call_config` and `event_subscriptions` sit under `version_details`, keyed by version ID. For an outbound-inbound agent, add `type=inbound` to get its inbound settings. A `404` means no agent with that ID exists in the workspace that owns the API key. Use it to check that an `agent_id` stored in your system still points at the agent you expect, for example after a call behaved unexpectedly. ## OpenAPI ````yaml get /agent/{agent_id} openapi: 3.0.0 info: title: Ringg AI API Documentation description: >- The Ringg AI REST API. Base URL https://prod-api.ringg.ai/ca/api/v0; send your workspace API key in the X-API-KEY header from server-side code only. Requests and responses are JSON. version: 2.0.0 contact: name: Ringg AI support email: admin@ringg.ai url: https://docs.ringg.ai 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 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 Agent description: >- Retrieves one agent. Agent-level fields are on `agents`; each version's settings are under `agents.version_details`, keyed by version ID. operationId: getAssistantById parameters: - name: X-API-KEY in: header description: (Required) Your Ringg AI API key. required: true schema: type: string example: rg_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx - name: agent_id in: path description: (Required) ID of the agent to retrieve. required: true schema: type: string example: 00000000-0000-4000-8000-0000000000a1 - name: type in: query description: >- (Optional) Send `inbound` to get the inbound settings of an outbound-inbound agent. required: false schema: type: string enum: - inbound responses: '200': description: 'Successful Response: Detailed information about the agent.' content: application/json: schema: type: object properties: agents: type: object properties: id: type: string example: 00000000-0000-4000-8000-0000000000a1 agent_display_name: type: string example: EMI reminder agent_type: type: string enum: - inbound - outbound - outbound_inbound - whatsapp example: outbound orchestration_mode: type: string example: single_node form_fields: type: array items: type: object created_at: type: string format: date-time updated_at: type: string format: date-time inbound_number_id: type: string nullable: true telephony_id: type: string nullable: true template_id: type: string nullable: true template_name: type: string nullable: true template_label: type: string nullable: true template_icon: type: string nullable: true template_type: type: string nullable: true is_ab_live: type: boolean description: An A/B test between versions is live. example: false active_agent_version_id: type: string nullable: true example: 00000000-0000-4000-8000-0000000000d1 ab_versions: type: array items: {} derived_analytics_keys: {} classification_labels: type: array items: type: string previous_call_summary: description: >- Whether a returning caller's previous call summary is passed to the agent. webcall_public_key: type: string nullable: true version_details: type: object description: >- Settings per version, keyed by version ID. A multi-prompt agent returns only `custom_variables`, `tools` and `additional_languages` here. additionalProperties: type: object properties: language: type: string example: en-IN voice: type: object properties: id: type: string name: type: string example: Asha voice_preview: type: string format: uri image_url: type: string format: uri secondary_voice_id: type: string nullable: true secondary_language: type: string nullable: true additional_languages: type: array items: type: string agent_config: type: object description: >- The prompt and runtime settings, with `intro_message`, `custom_variables` and `interruption_sensitivity`. example: agent_prompt: prompt_sections: - section_title: Introduction and Objective section_content: >- You are Asha, calling Acme Lending customers about an upcoming EMI. intro_message: Hello, this is Asha from Acme Lending. custom_variables: - callee_name - mobile_number tools: type: array items: type: object pre_call_tools: type: array items: type: object on_call_tools: type: array items: type: object post_call_tools: type: array items: type: object knowledge_bases: type: array items: type: object call_config: type: object chat_config: type: object nullable: true event_subscriptions: type: array items: type: object custom_analysis_prompt: type: string nullable: true client_analysis: type: object nullable: true whitelisted_domains: type: array items: type: string '401': description: Unauthorized - Invalid or missing API key. content: application/json: schema: type: object properties: message: type: string example: Invalid credentials '404': description: Not Found - Resource doesn't exist. content: application/json: schema: type: object properties: message: type: string '500': description: Internal Server Error - Something went wrong on our end. content: application/json: schema: type: object properties: message: type: string example: An unexpected error occurred. Please try again later. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.