> ## Documentation Index
> Fetch the complete documentation index at: https://dialnexa.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Agent Details
> Fetch one agent with versions and embedded configuration.
Read only
**Recommended.** This endpoint is part of the public `/v1` API reference and is the supported path for new integrations. See the [migration guide](/docs/api-reference/v1/migrating-to-v1) for versioning guidance.
Fetch one agent by its `id`. The request is scoped to the authenticated organization automatically. The response includes the agent's versions, so this is the endpoint to call when you need the full configuration rather than a list summary.
## When to use this
* **Before an update**: fetch the current configuration and version numbers, then send only the changed fields to [Update Agent](/docs/api-reference/v1/agents/update).
* **Config review**: confirm which version is published and what prompt, voice, and LLM it uses before routing production calls to it.
* **Syncing**: mirror agent configuration into your own admin UI or configuration store.
If the agent does not exist or belongs to another organization, the API returns `404 Not Found`. See [Errors](/docs/api-reference/errors) for the standard error format.
## OpenAPI
````yaml GET /v1/agents/{id}
openapi: 3.0.0
info:
title: DialNexa API
description: >-
Public REST API for the DialNexa voice AI platform. Versioned endpoints are
under /v1; unversioned endpoints are legacy and deprecated.
version: 1.0.0
servers:
- url: https://api.dialnexa.com
description: DialNexa production API
security:
- bearer: []
tags:
- name: API Keys
- name: Agent Functions
- name: Agents V1
- name: Agents2
- name: Batch Calls
- name: Batch Calls V1
- name: Call Logs
- name: Calls
- name: Calls V1
- name: Campaign Leads
- name: Campaigns
- name: External Webhooks
- name: Knowledge Base
- name: Knowledge Base V1
- name: LLMs
- name: LLMs V1
- name: Languages
- name: Languages V1
- name: Organization Phone Numbers
- name: Organization Phone Numbers V1
- name: Phone Number Pricing
- name: Phone Number Pricing V1
- name: Transcribers
- name: Transcribers V1
- name: User Webhooks
- name: User Webhooks V1
- name: V1
- name: Voices
- name: Voices V1
- name: Webcall
- name: Workflow Leads
- name: Workflow Leads V1
- name: Workflows
- name: Workflows V1
paths:
/v1/agents/{id}:
get:
tags:
- Agents V1
- V1
summary: Get Agent Details
description: >-
Returns the agent with all versions. Each version includes
`agent_functions`, `pronunciations`, and `postcall_analysis` embedded.
operationId: AgentsV1Controller_findOne
parameters:
- name: id
required: true
in: path
description: Agent ID
schema:
example: agent_2g7Xy3tY53gRlp
type: string
responses:
'200':
description: Agent returned with all versions and embedded agent_functions.
content:
application/json:
schema:
$ref: '#/components/schemas/Agents'
examples:
success:
summary: Successful response
value:
id: agent_2g7Xy3tY53gRlp
folder_id: null
current_version_number: 1
timezone: Asia/Kolkata
agent_type: Single_Prompt_Agent
pipeline_type: Cascaded
webhook_id: null
current_version:
agent_id: agent_2g7Xy3tY53gRlp
version_number: 1
version_title: Version 1
title: Customer Support Agent
is_published: false
language_id: lang_en_in
voice_id: voice_abc123
llm_id: llm_A1B2C3D4E5F6G7
transcriber_id: trs_deepgram_nova_2
fallback_stt_enabled: true
stt_fallback_transcriber_id: trs_soniox
post_call_analysis_llm_id: llm_A1B2C3D4E5F6G7
versions:
- agent_id: agent_2g7Xy3tY53gRlp
version_number: 1
version_title: Version 1
title: Customer Support Agent
is_published: false
language_id: lang_en_in
voice_id: voice_abc123
llm_id: llm_A1B2C3D4E5F6G7
transcriber_id: trs_deepgram_nova_2
fallback_stt_enabled: true
stt_fallback_transcriber_id: trs_soniox
post_call_analysis_llm_id: llm_A1B2C3D4E5F6G7
'400':
description: Invalid agent ID format.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 400 Bad Request
value:
statusCode: 400
message: Invalid query parameters
error: Bad Request
'401':
description: Unauthorized.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 401 Unauthorized
value:
statusCode: 401
message: API key is missing or invalid
error: Unauthorized
'403':
description: Forbidden - agent does not belong to your organization.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 403 Forbidden
value:
statusCode: 403
message: You do not have permission to access this resource
error: Forbidden
'404':
description: Agent not found.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 404 Not Found
value:
statusCode: 404
message: Agent not found
error: Not Found
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
error:
summary: 500 Internal Server Error
value:
statusCode: 500
message: Internal server error
error: Internal Server Error
security:
- bearer: []
components:
schemas:
Agents:
type: object
properties:
id:
type: string
example: agent_2g7Xy3tY53gRlp
description: Signed agent ID
folder_id:
type: string
nullable: true
current_version_number:
type: integer
nullable: true
timezone:
type: string
nullable: true
agent_type:
type: string
enum:
- Single_Prompt_Agent
- Conversational_Flow_Agent
pipeline_type:
type: string
enum:
- Cascaded
- Speech_To_Speech
nullable: true
webhook_id:
type: string
nullable: true
current_version:
type: object
properties:
agent_id:
type: string
version_number:
type: integer
version_title:
type: string
nullable: true
title:
type: string
nullable: true
is_published:
type: boolean
language_id:
type: string
nullable: true
voice_id:
type: string
nullable: true
llm_id:
type: string
nullable: true
transcriber_id:
type: string
nullable: true
fallback_stt_enabled:
type: boolean
stt_fallback_transcriber_id:
type: string
nullable: true
post_call_analysis_llm_id:
type: string
nullable: true
nullable: true
versions:
type: array
items:
type: object
properties:
agent_id:
type: string
version_number:
type: integer
version_title:
type: string
nullable: true
title:
type: string
nullable: true
is_published:
type: boolean
language_id:
type: string
nullable: true
voice_id:
type: string
nullable: true
llm_id:
type: string
nullable: true
transcriber_id:
type: string
nullable: true
fallback_stt_enabled:
type: boolean
stt_fallback_transcriber_id:
type: string
nullable: true
post_call_analysis_llm_id:
type: string
nullable: true
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
required:
- id
- agent_type
ErrorResponse:
type: object
properties:
statusCode:
type: integer
example: 400
message:
oneOf:
- type: string
- type: array
items:
type: string
example: phone_number must be a valid E.164 phone number
error:
type: string
example: Bad Request
required:
- statusCode
- message
- error
securitySchemes:
bearer:
scheme: bearer
bearerFormat: JWT
type: http
````