Overview
Retrieve the complete details of an AI agent using its unique Agent ID. This endpoint returns the agent configuration, including its prompt, voice settings, conversation configuration, and associated knowledge bases.Prerequisites
- Bearer token for an authenticated workspace
- Valid Agent ID
Request
string
required
Bearer token for authenticated workspace access.
string
required
Unique identifier of the AI agent.
Response
boolean
required
Indicates whether the request completed successfully.
integer
required
HTTP status code returned by the API.
string
required
Human-readable success message.
object
required
Complete AI agent configuration and metadata.
string
Unique identifier of the AI agent.
string
Display name of the AI agent.
string
Configured voice gender.
string
Voice model assigned to the AI agent.
string
Conversation configuration type.
string
Primary instruction prompt that defines the AI agent’s behavior.
string
Greeting message spoken at the beginning of the conversation.
array[string]
Knowledge Base IDs associated with the AI agent.
Error Handling
- 400 Bad Request – Invalid Agent ID format.
- 401 Unauthorized – Missing or invalid Bearer token.
- 403 Forbidden – You do not have permission to access this agent.
- 404 Not Found – No AI agent found for the provided ID.
- 500 Internal Server Error – Unexpected server error.
Use this endpoint whenever you need the complete configuration of an AI agent before updating or assigning it to campaigns.
You can use the returned Agent ID with:
PATCH /api/agents/{id}to update the agent.DELETE /api/agents/{id}to permanently remove the agent.