Get assistant by ID

import requests
url = "https://www.getrevox.com/api/assistants/id"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "id": "string",
  "prompt": "string",
  "first_sentence": "string",
  "first_sentence_mode": "generated",
  "end_of_call_sentence": "string",
  "voice": {
    "provider": "cartesia",
    "id": "string",
    "speed": 1.1
  },
  "llm_model": {
    "type": "string",
    "name": "gpt-4.1"
  },
  "webhook_url": "string",
  "max_call_duration_secs": 1.1,
  "structured_output_config": [
    {
      "name": "string",
      "type": "string",
      "required": false,
      "description": "string",
      "enum_options": [
        "string"
      ]
    }
  ],
  "call_retry_config": {
    "calling_windows": [
      {
        "calling_window_start_time": "string",
        "calling_window_end_time": "string",
        "retry_delay_seconds": 7200
      }
    ],
    "max_retry_attempts": 3,
    "timezone": "string"
  },
  "background_sound": "audio/office.ogg",
  "transfer_phone_number": "string",
  "ivr_navigation_enabled": true,
  "voicemail_message": "string",
  "first_sentence_delay_ms": 1,
  "calendly": {
    "connection_id": "string",
    "event_type_id": "string"
  },
  "organization_id": "string",
  "name": "string",
  "faq_items": [
    {
      "question": "string",
      "answer": "string",
      "id": "string",
      "needs_human_answer": true,
      "source": "human"
    }
  ],
  "pending_faq_count": 1.1
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Response

200

idstring

promptstring

first_sentencestring or null

first_sentence_modeenum

Allowed values:

end_of_call_sentencestring or null

voiceobject or null

llm_modelobject

webhook_urlstring or null

The webhook URL to call when the call is completed.

max_call_duration_secsdouble

The maximum duration of the call in seconds. This is the maximum time the call will be allowed to run.

structured_output_configlist of objects or null

The structured output config to use for the call. This is used to extract the data from the call (like email, name, company name, etc.).

call_retry_configobject or null

Configuration for call retry behavior including time windows, delays, and max iterations.

background_soundenum or null

The background sound to play during the call. Useful to give the impression that your AI agent is in an office.

Allowed values:

transfer_phone_numberstring or null

Phone number to transfer calls to when users request to speak to a human agent.

ivr_navigation_enabledboolean

Enable IVR navigation tools. When enabled, the assistant can send DTMF tones and skip turns to navigate phone menus.

voicemail_messagestring or null

If set, when voicemail is detected the agent will speak this message then hang up; if null, hang up immediately.

first_sentence_delay_msinteger-9007199254740991-9007199254740991

Delay in milliseconds before speaking the first sentence. Default: 400.

calendlyobject or null

organization_idstring

namestring

created_atany

updated_atany

faq_itemslist of objects or null

pending_faq_countdouble or null