Skip to main content
GET
/
assistants
/
{id}
cURL
curl --request GET \
  --url https://www.getrevox.com/api/assistants/{id}
{
  "prompt": "<string>",
  "first_sentence": "<string>",
  "first_sentence_mode": "generated",
  "voice": {
    "provider": "cartesia",
    "id": "<string>"
  },
  "webhook_url": "<string>",
  "max_call_duration_secs": 123,
  "structured_output_config": [
    {
      "name": "<string>",
      "type": "string",
      "required": false,
      "description": "<string>",
      "enum_options": [
        "<string>"
      ]
    }
  ],
  "call_retry_config": {
    "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",
  "id": "<string>",
  "organization_id": "<string>",
  "name": "<string>",
  "created_at": "<unknown>",
  "updated_at": "<unknown>",
  "faq_items": [
    {
      "question": "<string>",
      "answer": "<string>",
      "id": "<string>",
      "needs_human_answer": true,
      "source": "human"
    }
  ],
  "pending_faq_count": 123
}

Headers

​
authorization
string

Bearer auth token. Example: Bearer sk_123...

Path Parameters

​
id
string
required

Response

200 - application/json

200

​
prompt
string
required
​
first_sentence
string | null
required
​
first_sentence_mode
enum<string>
required
Available options:
generated,
static,
none
​
voice
object
required
​
webhook_url
string | null
required

The webhook URL to call when the call is completed.

​
max_call_duration_secs
number
required

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

​
structured_output_config
object[] | null
required

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_config
object
required

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

​
background_sound
enum<string> | null
required

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

Available options:
audio/office.ogg
​
id
string
required
​
organization_id
string
required
​
name
string
required
​
created_at
any
required
​
updated_at
any
required
​
faq_items
object[]
​
pending_faq_count
number