Sign in
Class 5 - AI Agent

Read

Retrieve a single Class 5 - AI Agent record by ID.

get/api/cp/class5/ai-agent/{id}

Path parameters

idinteger required

Id identifier

Response

Successful response

idstring

Id

account_idinteger

Account Id

company_idinteger

Company Id

app_idstring

App Id

deststring

Dest

hoststring

Host

pbx_serverstring

Pbx Server

namestring

Name

promptstring

Prompt

platform'openai' | 'converse' | 'converse-direct' | 'converse2'

Platform

providerstring

Provider

modelstring

Model

transcriberstring

Transcriber

transcriber_modelstring

Transcriber Model

transcriber_silence_thresholdnumber

Transcriber Silence Threshold

transcriber_languagestring

Transcriber Language

ttsstring

Tts

voicestring

Voice

first_messagestring

First Message

endpoint_idstring

Endpoint Id

vadinteger

Vad

early_end_turn_thresholdnumber

Early End Turn Threshold

end_turn_thresholdnumber

End Turn Threshold

temperaturenumber

Temperature

built_in_functionsstring

Built In Functions

end_call_phrasesstring

End Call Phrases

interrupt_delaynumber

Interrupt Delay

guard_railsstring

Guard Rails

filler_wordsstring

Filler Words

min_filler_word_delaynumber

Min Filler Word Delay

office_background_volumenumber

Office Background Volume

flagsstring[]

Flags

llm_timeoutnumber

Llm Timeout

llm_retriesinteger

Llm Retries

amd_keywordsstring

Amd Keywords

varsstring

Vars

transcriber_timeoutinteger

Transcriber Timeout

tool_call_allow_liststring

Tool Call Allow List

precache_phrasesstring

Precache Phrases

first_task_idstring

First Task Id

kb_idstring

Kb Id

asr_provider_config_idstring

Asr Provider Config Id (references converse_provider_config.id)

llm_provider_config_idstring

Llm Provider Config Id (references converse_provider_config.id)

tts_provider_config_idstring

Tts Provider Config Id (references converse_provider_config.id)

s2s_provider_config_idstring

S 2 S Provider Config Id (references converse_provider_config.id)

mcp_serversobject

Mcp Servers

Example response

{
  "id": 12345,
  "account_id": 1,
  "company_id": 1,
  "app_id": 1,
  "dest": "example_dest",
  "host": "example_host",
  "pbx_server": "example_pbx_server",
  "name": "Example Name",
  "prompt": "Sample prompt text content",
  "platform": "openai",
  "provider": "example_provider",
  "model": "example_model",
  "transcriber": "example_transcriber",
  "transcriber_model": "example_transcriber_model",
  "transcriber_silence_threshold": 99.99,
  "transcriber_language": "example_transcriber_language",
  "tts": "example_tts",
  "voice": "example_voice",
  "first_message": "example_first_message",
  "endpoint_id": 1,
  "vad": 1,
  "early_end_turn_threshold": 99.99,
  "end_turn_threshold": 99.99,
  "temperature": 99.99,
  "built_in_functions": "example_built_in_functions",
  "end_call_phrases": "example_end_call_phrases",
  "interrupt_delay": 99.99,
  "guard_rails": "example_guard_rails",
  "filler_words": "example_filler_words",
  "min_filler_word_delay": 99.99,
  "office_background_volume": 99.99,
  "flags": "ASYNC_GUARD_RAILS",
  "llm_timeout": 99.99,
  "llm_retries": 1,
  "amd_keywords": "example_amd_keywords",
  "vars": "example_vars",
  "transcriber_timeout": 1,
  "tool_call_allow_list": "example_tool_call_allow_list",
  "precache_phrases": "example_precache_phrases",
  "first_task_id": 1,
  "kb_id": 1,
  "asr_provider_config_id": 1,
  "llm_provider_config_id": 1,
  "tts_provider_config_id": 1,
  "s2s_provider_config_id": 1,
  "mcp_servers": "Sample mcp_servers text content"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.