Get assistant by ID
Retrieve a single assistant by its unique ID. Returns the full assistant configuration including prompt, voice settings, and first sentence mode. Useful for inspecting an assistant’s current setup before updating it or placing a call.
Returns
Ambient background sound to play during the call. null disables it.
Volume of the ambient background sound (0 = silent, 1 = max).
Optional Cartesia pronunciation dictionary ID linked to this assistant.
Delay in milliseconds before speaking the first sentence. Default: 400.
Override the default outbound phone number for calls placed with this assistant. When null, the organization’s default phone number is used.
When true, the agent’s noise-cancellation filter is Krisp VIVA Tel instead of the legacy BVCTelephony.
The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.
Optional message the agent will say, without being interruptible, when the call reaches its max duration. Kept short so it fits inside the farewell buffer. If null, the call ends silently.
URL fetched before an inbound call is answered to resolve the assistant’s prompt variables. Null when no lookup is configured.
Custom prompt for structured data extraction. If not provided, a default prompt is used. Available variables: {{transcript}}, {{call_direction}}, {{user_phone_number}}, {{agent_phone_number}}.
When false, the agent transcribes the raw caller track instead of the BVC noise-cancellation output.
Soniox endpoint latency adjustment level (0 to 3). Null: Soniox default.
Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.
If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.
Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.
Get assistant by ID
curl https://www.getrevox.com/api/assistants/$ID \
-H "Authorization: Bearer $REVOX_API_KEY"{
"id": "id",
"background_sound": "audio/office.ogg",
"background_sound_volume": 0,
"cal": {
"connection_id": "connection_id",
"event_type_id": "event_type_id"
},
"calendly": {
"connection_id": "connection_id",
"event_type_id": "event_type_id"
},
"call_retry_config": {
"allowed_days": [
"monday"
],
"call_twice_in_a_row": true,
"calling_windows": [
{
"calling_window_end_time": "calling_window_end_time",
"calling_window_start_time": "calling_window_start_time",
"retry_delay_seconds": {}
}
],
"max_retry_attempts": 1,
"timezone": "timezone"
},
"cartesia_dictionary_pronunciation_id": "cartesia_dictionary_pronunciation_id",
"created_at": {},
"custom_tools": [
{
"body_template": "body_template",
"description": "x",
"headers": [
{
"key": "x",
"value": "value"
}
],
"input_schema": [
{
"name": "x",
"required": true,
"type": "string",
"description": "description",
"enum_options": [
"string"
]
}
],
"method": "GET",
"name": "name",
"query_params": [
{
"key": "x",
"value": "value"
}
],
"url": "x"
}
],
"end_of_call_sentence": "end_of_call_sentence",
"first_sentence": "first_sentence",
"first_sentence_delay_ms": -9007199254740991,
"first_sentence_mode": "generated",
"from_phone_number": "from_phone_number",
"hubspot": {
"connection_id": "connection_id",
"meeting_links": [
{
"booking_url": "booking_url",
"duration_ms": 1,
"is_fallback": true,
"label": "x",
"slug": "x"
}
],
"precall_lookup_enabled": true,
"post_call_sync": {
"enabled": true,
"field_mapping": [
{
"hubspot_property": "x",
"source": "x"
}
]
}
},
"human_transfer_mode": "warm",
"ivr_navigation_enabled": true,
"krisp_viva_filter_enabled": true,
"llm_model": {
"type": "recommended"
},
"logo_url": "logo_url",
"max_call_duration_secs": 0,
"max_duration_end_message": "max_duration_end_message",
"name": "name",
"organization_id": "organization_id",
"position": {
"x": 0,
"y": 0
},
"post_call_prompt": "post_call_prompt",
"precall_lookup_headers": [
{
"key": "key",
"value": "x"
}
],
"precall_lookup_url": "precall_lookup_url",
"prompt": "prompt",
"slack": {
"channels": [
{
"id": "id",
"name": "name"
}
],
"connection_id": "connection_id"
},
"start_step_name": "start_step_name",
"structured_output_config": [
{
"name": "x",
"required": true,
"type": "string",
"description": "description",
"enum_options": [
"string"
]
}
],
"structured_output_prompt": "structured_output_prompt",
"stt_bvc_filter_enabled": true,
"stt_context": {
"general": [
{
"key": "x",
"value": "x"
}
],
"terms": [
"x"
]
},
"stt_endpoint_latency_level": -9007199254740991,
"stt_endpoint_sensitivity": 0,
"stt_model": "stt-rt-v4",
"teams": {
"channels": [
{
"id": "id",
"team_id": "team_id",
"name": "name",
"team_name": "team_name"
}
],
"connection_id": "connection_id"
},
"thinking_sound": "city-ambience.ogg",
"thinking_sound_probability": 0,
"thinking_sound_volume": 0,
"transfer_destinations": [
{
"label": "x",
"phone_number": "phone_number"
}
],
"type": "standalone",
"updated_at": {},
"voice": {
"id": "x",
"provider": "cartesia",
"model": "sonic-3",
"speed": 0.6,
"volume": 0.5
},
"voice_languages": [
{
"language": "en",
"voice": {
"id": "x",
"provider": "cartesia",
"model": "sonic-3",
"speed": 0.6,
"volume": 0.5
}
}
],
"voicemail_message": "voicemail_message",
"warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
"warm_transfer_voice_speed": 0.6,
"webhook_url": "webhook_url",
"zoho": {
"connection_id": "connection_id",
"field_mapping": [
{
"source": "x",
"zoho_field": "x"
}
],
"log_call_activity": true,
"module": "x",
"template": "template"
},
"created_by": {
"id": "id",
"email": "email",
"first_name": "first_name",
"last_name": "last_name"
},
"is_inbound_receptionist": true,
"is_realestate_assistant": true
}Returns Examples
{
"id": "id",
"background_sound": "audio/office.ogg",
"background_sound_volume": 0,
"cal": {
"connection_id": "connection_id",
"event_type_id": "event_type_id"
},
"calendly": {
"connection_id": "connection_id",
"event_type_id": "event_type_id"
},
"call_retry_config": {
"allowed_days": [
"monday"
],
"call_twice_in_a_row": true,
"calling_windows": [
{
"calling_window_end_time": "calling_window_end_time",
"calling_window_start_time": "calling_window_start_time",
"retry_delay_seconds": {}
}
],
"max_retry_attempts": 1,
"timezone": "timezone"
},
"cartesia_dictionary_pronunciation_id": "cartesia_dictionary_pronunciation_id",
"created_at": {},
"custom_tools": [
{
"body_template": "body_template",
"description": "x",
"headers": [
{
"key": "x",
"value": "value"
}
],
"input_schema": [
{
"name": "x",
"required": true,
"type": "string",
"description": "description",
"enum_options": [
"string"
]
}
],
"method": "GET",
"name": "name",
"query_params": [
{
"key": "x",
"value": "value"
}
],
"url": "x"
}
],
"end_of_call_sentence": "end_of_call_sentence",
"first_sentence": "first_sentence",
"first_sentence_delay_ms": -9007199254740991,
"first_sentence_mode": "generated",
"from_phone_number": "from_phone_number",
"hubspot": {
"connection_id": "connection_id",
"meeting_links": [
{
"booking_url": "booking_url",
"duration_ms": 1,
"is_fallback": true,
"label": "x",
"slug": "x"
}
],
"precall_lookup_enabled": true,
"post_call_sync": {
"enabled": true,
"field_mapping": [
{
"hubspot_property": "x",
"source": "x"
}
]
}
},
"human_transfer_mode": "warm",
"ivr_navigation_enabled": true,
"krisp_viva_filter_enabled": true,
"llm_model": {
"type": "recommended"
},
"logo_url": "logo_url",
"max_call_duration_secs": 0,
"max_duration_end_message": "max_duration_end_message",
"name": "name",
"organization_id": "organization_id",
"position": {
"x": 0,
"y": 0
},
"post_call_prompt": "post_call_prompt",
"precall_lookup_headers": [
{
"key": "key",
"value": "x"
}
],
"precall_lookup_url": "precall_lookup_url",
"prompt": "prompt",
"slack": {
"channels": [
{
"id": "id",
"name": "name"
}
],
"connection_id": "connection_id"
},
"start_step_name": "start_step_name",
"structured_output_config": [
{
"name": "x",
"required": true,
"type": "string",
"description": "description",
"enum_options": [
"string"
]
}
],
"structured_output_prompt": "structured_output_prompt",
"stt_bvc_filter_enabled": true,
"stt_context": {
"general": [
{
"key": "x",
"value": "x"
}
],
"terms": [
"x"
]
},
"stt_endpoint_latency_level": -9007199254740991,
"stt_endpoint_sensitivity": 0,
"stt_model": "stt-rt-v4",
"teams": {
"channels": [
{
"id": "id",
"team_id": "team_id",
"name": "name",
"team_name": "team_name"
}
],
"connection_id": "connection_id"
},
"thinking_sound": "city-ambience.ogg",
"thinking_sound_probability": 0,
"thinking_sound_volume": 0,
"transfer_destinations": [
{
"label": "x",
"phone_number": "phone_number"
}
],
"type": "standalone",
"updated_at": {},
"voice": {
"id": "x",
"provider": "cartesia",
"model": "sonic-3",
"speed": 0.6,
"volume": 0.5
},
"voice_languages": [
{
"language": "en",
"voice": {
"id": "x",
"provider": "cartesia",
"model": "sonic-3",
"speed": 0.6,
"volume": 0.5
}
}
],
"voicemail_message": "voicemail_message",
"warm_transfer_summary_instructions": "warm_transfer_summary_instructions",
"warm_transfer_voice_speed": 0.6,
"webhook_url": "webhook_url",
"zoho": {
"connection_id": "connection_id",
"field_mapping": [
{
"source": "x",
"zoho_field": "x"
}
],
"log_call_activity": true,
"module": "x",
"template": "template"
},
"created_by": {
"id": "id",
"email": "email",
"first_name": "first_name",
"last_name": "last_name"
},
"is_inbound_receptionist": true,
"is_realestate_assistant": true
}