Get an AI assistant

Retrieve one AI assistant with its full configuration.

Endpoint

GET
/ai-assistants/:id

Path parameters

NameTypeRequiredDescription
idintegerYesAI assistant ID.

Query parameters

NameTypeRequiredDescription
$syncFromTelnyxbooleanNoVoice assistants only. Refreshes the stored telnyx_ai_assistant_config from the voice provider before returning it.
$select[]stringNoReturn only these fields.

Request

Refresh a voice assistant from the voice provider:

Response

json

Returns the full AI assistant object (shortened above) plus the read-only ai_safeguards_system object with the system default and allowed range of every safeguard.

Errors

StatusWhen
404The assistant does not exist, is deleted, or belongs to another organization.

Report an issue with this documentation

Please log in to report issues with our documentation.