# Assistants

## Create

`assistants.create(**kwargs) -> AssistantCreateResponse`

**post** `/assistants`

Create a new AI assistant with a custom prompt, voice, and behavior configuration. Assistants define how the AI agent behaves during calls, including the system prompt given to the LLM, the first sentence spoken, the voice provider and voice ID (Cartesia or ElevenLabs), and end-of-call behavior. Once created, reference the assistant by its ID when placing calls.

### Parameters

- `name: String`

- `prompt: String`

  The prompt to use for the call. This will be given to the LLM (gpt-4.1)

- `background_sound: :"audio/office.ogg"`

  The background sound to play during the call. Useful to give the impression that your AI agent is in an office, in the street, or anywhere else you want.

  - `:"audio/office.ogg"`

- `calendly: { connection_id, event_type_id}`

  - `connection_id: String`

    The connection ID representing the link between your Calendly account and Revox.

  - `event_type_id: String`

    The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

- `call_retry_config: { calling_windows, max_retry_attempts, timezone}`

  Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

  - `calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]`

    - `calling_window_end_time: String`

      End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

    - `calling_window_start_time: String`

      Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

    - `retry_delay_seconds: Integer`

      Delay between retry attempts in seconds. Default: 7200 (2 hours).

  - `max_retry_attempts: Integer`

    Maximum number of call retry attempts. Default: 3.

  - `timezone: String`

    Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

- `end_of_call_sentence: String`

  Optional message to say when the agent decides to end the call.

- `faq_items: Array[{ answer, question}]`

  FAQ items to associate with this assistant. When provided, replaces all existing FAQ items.

  - `answer: String`

  - `question: String`

- `first_sentence: String`

  The first sentence to use for the call. This will be given to the LLM

- `first_sentence_delay_ms: Integer`

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

- `first_sentence_mode: :generated | :static | :none`

  How the first sentence should be handled. "generated" means the LLM will generate a response based on the first_sentence instruction. "static" means the first_sentence will be spoken exactly as provided. "none" means the agent will not speak first and will wait for the user.

  - `:generated`

  - `:static`

  - `:none`

- `ivr_navigation_enabled: bool`

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

- `llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type}`

  - `class UnionMember0`

    - `name: :"gpt-4.1" | :"ministral-3-8b-instruct"`

      - `:"gpt-4.1"`

      - `:"ministral-3-8b-instruct"`

    - `type: :"dedicated-instance"`

      - `:"dedicated-instance"`

  - `class UnionMember1`

    - `openrouter_model_id: String`

      The model ID to use from OpenRouter. eg: openai/gpt-4.1

    - `openrouter_provider: String`

      The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

    - `type: :openrouter`

      Use a model from OpenRouter.

      - `:openrouter`

- `max_call_duration_secs: Float`

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

- `structured_output_config: Array[{ name, required, type, 2 more}]`

  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.).

  - `name: String`

  - `required: bool`

  - `type: :string | :number | :boolean | 3 more`

    - `:string`

    - `:number`

    - `:boolean`

    - `:enum`

    - `:date`

    - `:datetime`

  - `description: String`

  - `enum_options: Array[String]`

- `transfer_phone_number: String`

  Phone number to transfer calls to when users request to speak to a human agent in E.164 format (e.g. +1234567890).

- `voice: { id, provider, speed}`

  The voice to use for the call. You can get the list of voices using the /voices endpoint

  - `id: String`

    The ID of the voice.

  - `provider: :cartesia | :elevenlabs`

    The provider of the voice.

    - `:cartesia`

    - `:elevenlabs`

  - `speed: Float`

    The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

- `voicemail_message: String`

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

- `webhook_url: String`

  The webhook URL to call when the call is completed.

### Returns

- `class AssistantCreateResponse`

  - `assistant: { id, background_sound, calendly, 20 more}`

    - `id: String`

    - `background_sound: :"audio/office.ogg"`

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

      - `:"audio/office.ogg"`

    - `calendly: { connection_id, event_type_id}`

      - `connection_id: String`

        The connection ID representing the link between your Calendly account and Revox.

      - `event_type_id: String`

        The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

    - `call_retry_config: { calling_windows, max_retry_attempts, timezone}`

      Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

      - `calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]`

        - `calling_window_end_time: String`

          End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

        - `calling_window_start_time: String`

          Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

        - `retry_delay_seconds: Integer`

          Delay between retry attempts in seconds. Default: 7200 (2 hours).

      - `max_retry_attempts: Integer`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: String`

        Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

    - `created_at: untyped`

    - `end_of_call_sentence: String`

    - `first_sentence: String`

    - `first_sentence_delay_ms: Integer`

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

    - `first_sentence_mode: :generated | :static | :none`

      - `:generated`

      - `:static`

      - `:none`

    - `ivr_navigation_enabled: bool`

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

    - `llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type}`

      - `class UnionMember0`

        - `name: :"gpt-4.1" | :"ministral-3-8b-instruct"`

          - `:"gpt-4.1"`

          - `:"ministral-3-8b-instruct"`

        - `type: :"dedicated-instance"`

          - `:"dedicated-instance"`

      - `class UnionMember1`

        - `openrouter_model_id: String`

          The model ID to use from OpenRouter. eg: openai/gpt-4.1

        - `openrouter_provider: String`

          The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

        - `type: :openrouter`

          Use a model from OpenRouter.

          - `:openrouter`

    - `max_call_duration_secs: Float`

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

    - `name: String`

    - `organization_id: String`

    - `prompt: String`

    - `structured_output_config: Array[{ name, required, type, 2 more}]`

      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.).

      - `name: String`

      - `required: bool`

      - `type: :string | :number | :boolean | 3 more`

        - `:string`

        - `:number`

        - `:boolean`

        - `:enum`

        - `:date`

        - `:datetime`

      - `description: String`

      - `enum_options: Array[String]`

    - `transfer_phone_number: String`

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

    - `updated_at: untyped`

    - `voice: { id, provider, speed}`

      - `id: String`

        The ID of the voice.

      - `provider: :cartesia | :elevenlabs`

        The provider of the voice.

        - `:cartesia`

        - `:elevenlabs`

      - `speed: Float`

        The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

    - `voicemail_message: String`

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

    - `webhook_url: String`

      The webhook URL to call when the call is completed.

    - `faq_items: Array[{ answer, question, id, 2 more}]`

      - `answer: String`

      - `question: String`

      - `id: String`

      - `needs_human_answer: bool`

      - `source: :human | :ai`

        - `:human`

        - `:ai`

    - `pending_faq_count: Float`

### Example

```ruby
require "revox"

revox = Revox::Client.new(api_key: "My API Key")

assistant = revox.assistants.create(name: "name", prompt: "prompt")

puts(assistant)
```

## List

`assistants.list() -> AssistantListResponse`

**get** `/assistants`

Retrieve all assistants associated with your account. Each assistant in the response includes its full configuration: prompt, voice settings, and first sentence. Use this endpoint to list available assistants before placing calls.

### Returns

- `class AssistantListResponse`

  - `assistants: Array[{ id, background_sound, calendly, 20 more}]`

    - `id: String`

    - `background_sound: :"audio/office.ogg"`

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

      - `:"audio/office.ogg"`

    - `calendly: { connection_id, event_type_id}`

      - `connection_id: String`

        The connection ID representing the link between your Calendly account and Revox.

      - `event_type_id: String`

        The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

    - `call_retry_config: { calling_windows, max_retry_attempts, timezone}`

      Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

      - `calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]`

        - `calling_window_end_time: String`

          End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

        - `calling_window_start_time: String`

          Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

        - `retry_delay_seconds: Integer`

          Delay between retry attempts in seconds. Default: 7200 (2 hours).

      - `max_retry_attempts: Integer`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: String`

        Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

    - `created_at: untyped`

    - `end_of_call_sentence: String`

    - `first_sentence: String`

    - `first_sentence_delay_ms: Integer`

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

    - `first_sentence_mode: :generated | :static | :none`

      - `:generated`

      - `:static`

      - `:none`

    - `ivr_navigation_enabled: bool`

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

    - `llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type}`

      - `class UnionMember0`

        - `name: :"gpt-4.1" | :"ministral-3-8b-instruct"`

          - `:"gpt-4.1"`

          - `:"ministral-3-8b-instruct"`

        - `type: :"dedicated-instance"`

          - `:"dedicated-instance"`

      - `class UnionMember1`

        - `openrouter_model_id: String`

          The model ID to use from OpenRouter. eg: openai/gpt-4.1

        - `openrouter_provider: String`

          The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

        - `type: :openrouter`

          Use a model from OpenRouter.

          - `:openrouter`

    - `max_call_duration_secs: Float`

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

    - `name: String`

    - `organization_id: String`

    - `prompt: String`

    - `structured_output_config: Array[{ name, required, type, 2 more}]`

      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.).

      - `name: String`

      - `required: bool`

      - `type: :string | :number | :boolean | 3 more`

        - `:string`

        - `:number`

        - `:boolean`

        - `:enum`

        - `:date`

        - `:datetime`

      - `description: String`

      - `enum_options: Array[String]`

    - `transfer_phone_number: String`

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

    - `updated_at: untyped`

    - `voice: { id, provider, speed}`

      - `id: String`

        The ID of the voice.

      - `provider: :cartesia | :elevenlabs`

        The provider of the voice.

        - `:cartesia`

        - `:elevenlabs`

      - `speed: Float`

        The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

    - `voicemail_message: String`

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

    - `webhook_url: String`

      The webhook URL to call when the call is completed.

    - `faq_items: Array[{ answer, question, id, 2 more}]`

      - `answer: String`

      - `question: String`

      - `id: String`

      - `needs_human_answer: bool`

      - `source: :human | :ai`

        - `:human`

        - `:ai`

    - `pending_faq_count: Float`

### Example

```ruby
require "revox"

revox = Revox::Client.new(api_key: "My API Key")

assistants = revox.assistants.list

puts(assistants)
```

## Retrieve

`assistants.retrieve(id) -> AssistantRetrieveResponse`

**get** `/assistants/{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.

### Parameters

- `id: String`

### Returns

- `class AssistantRetrieveResponse`

  - `id: String`

  - `background_sound: :"audio/office.ogg"`

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

    - `:"audio/office.ogg"`

  - `calendly: { connection_id, event_type_id}`

    - `connection_id: String`

      The connection ID representing the link between your Calendly account and Revox.

    - `event_type_id: String`

      The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

  - `call_retry_config: { calling_windows, max_retry_attempts, timezone}`

    Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

    - `calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]`

      - `calling_window_end_time: String`

        End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

      - `calling_window_start_time: String`

        Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

      - `retry_delay_seconds: Integer`

        Delay between retry attempts in seconds. Default: 7200 (2 hours).

    - `max_retry_attempts: Integer`

      Maximum number of call retry attempts. Default: 3.

    - `timezone: String`

      Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

  - `created_at: untyped`

  - `end_of_call_sentence: String`

  - `first_sentence: String`

  - `first_sentence_delay_ms: Integer`

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

  - `first_sentence_mode: :generated | :static | :none`

    - `:generated`

    - `:static`

    - `:none`

  - `ivr_navigation_enabled: bool`

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

  - `llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type}`

    - `class UnionMember0`

      - `name: :"gpt-4.1" | :"ministral-3-8b-instruct"`

        - `:"gpt-4.1"`

        - `:"ministral-3-8b-instruct"`

      - `type: :"dedicated-instance"`

        - `:"dedicated-instance"`

    - `class UnionMember1`

      - `openrouter_model_id: String`

        The model ID to use from OpenRouter. eg: openai/gpt-4.1

      - `openrouter_provider: String`

        The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

      - `type: :openrouter`

        Use a model from OpenRouter.

        - `:openrouter`

  - `max_call_duration_secs: Float`

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

  - `name: String`

  - `organization_id: String`

  - `prompt: String`

  - `structured_output_config: Array[{ name, required, type, 2 more}]`

    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.).

    - `name: String`

    - `required: bool`

    - `type: :string | :number | :boolean | 3 more`

      - `:string`

      - `:number`

      - `:boolean`

      - `:enum`

      - `:date`

      - `:datetime`

    - `description: String`

    - `enum_options: Array[String]`

  - `transfer_phone_number: String`

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

  - `updated_at: untyped`

  - `voice: { id, provider, speed}`

    - `id: String`

      The ID of the voice.

    - `provider: :cartesia | :elevenlabs`

      The provider of the voice.

      - `:cartesia`

      - `:elevenlabs`

    - `speed: Float`

      The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

  - `voicemail_message: String`

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

  - `webhook_url: String`

    The webhook URL to call when the call is completed.

  - `faq_items: Array[{ answer, question, id, 2 more}]`

    - `answer: String`

    - `question: String`

    - `id: String`

    - `needs_human_answer: bool`

    - `source: :human | :ai`

      - `:human`

      - `:ai`

  - `pending_faq_count: Float`

### Example

```ruby
require "revox"

revox = Revox::Client.new(api_key: "My API Key")

assistant = revox.assistants.retrieve("id")

puts(assistant)
```

## Update

`assistants.update(id, **kwargs) -> AssistantUpdateResponse`

**patch** `/assistants/{id}`

Update one or more fields on an existing assistant. Supports partial updates — only the fields you include in the request body will be changed. You can update the prompt, voice, first sentence, name, or any other assistant property without affecting the rest of the configuration.

### Parameters

- `id: String`

- `background_sound: :"audio/office.ogg"`

  The background sound to play during the call. Useful to give the impression that your AI agent is in an office, in the street, or anywhere else you want.

  - `:"audio/office.ogg"`

- `calendly: { connection_id, event_type_id}`

  - `connection_id: String`

    The connection ID representing the link between your Calendly account and Revox.

  - `event_type_id: String`

    The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

- `call_retry_config: { calling_windows, max_retry_attempts, timezone}`

  Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

  - `calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]`

    - `calling_window_end_time: String`

      End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

    - `calling_window_start_time: String`

      Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

    - `retry_delay_seconds: Integer`

      Delay between retry attempts in seconds. Default: 7200 (2 hours).

  - `max_retry_attempts: Integer`

    Maximum number of call retry attempts. Default: 3.

  - `timezone: String`

    Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

- `end_of_call_sentence: String`

  Optional message to say when the agent decides to end the call.

- `faq_items: Array[{ answer, question}]`

  FAQ items to associate with this assistant. When provided, replaces all existing FAQ items.

  - `answer: String`

  - `question: String`

- `first_sentence: String`

  The first sentence to use for the call. This will be given to the LLM

- `first_sentence_delay_ms: Integer`

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

- `first_sentence_mode: :generated | :static | :none`

  How the first sentence should be handled. "generated" means the LLM will generate a response based on the first_sentence instruction. "static" means the first_sentence will be spoken exactly as provided. "none" means the agent will not speak first and will wait for the user.

  - `:generated`

  - `:static`

  - `:none`

- `ivr_navigation_enabled: bool`

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

- `llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type}`

  - `class UnionMember0`

    - `name: :"gpt-4.1" | :"ministral-3-8b-instruct"`

      - `:"gpt-4.1"`

      - `:"ministral-3-8b-instruct"`

    - `type: :"dedicated-instance"`

      - `:"dedicated-instance"`

  - `class UnionMember1`

    - `openrouter_model_id: String`

      The model ID to use from OpenRouter. eg: openai/gpt-4.1

    - `openrouter_provider: String`

      The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

    - `type: :openrouter`

      Use a model from OpenRouter.

      - `:openrouter`

- `max_call_duration_secs: Float`

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

- `name: String`

- `prompt: String`

  The prompt to use for the call. This will be given to the LLM (gpt-4.1)

- `structured_output_config: Array[{ name, required, type, 2 more}]`

  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.).

  - `name: String`

  - `required: bool`

  - `type: :string | :number | :boolean | 3 more`

    - `:string`

    - `:number`

    - `:boolean`

    - `:enum`

    - `:date`

    - `:datetime`

  - `description: String`

  - `enum_options: Array[String]`

- `transfer_phone_number: String`

  Phone number to transfer calls to when users request to speak to a human agent in E.164 format (e.g. +1234567890).

- `voice: { id, provider, speed}`

  The voice to use for the call. You can get the list of voices using the /voices endpoint

  - `id: String`

    The ID of the voice.

  - `provider: :cartesia | :elevenlabs`

    The provider of the voice.

    - `:cartesia`

    - `:elevenlabs`

  - `speed: Float`

    The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

- `voicemail_message: String`

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

- `webhook_url: String`

  The webhook URL to call when the call is completed.

### Returns

- `class AssistantUpdateResponse`

  - `assistant: { id, background_sound, calendly, 20 more}`

    - `id: String`

    - `background_sound: :"audio/office.ogg"`

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

      - `:"audio/office.ogg"`

    - `calendly: { connection_id, event_type_id}`

      - `connection_id: String`

        The connection ID representing the link between your Calendly account and Revox.

      - `event_type_id: String`

        The event type ID representing the event type to schedule. (eg: https://api.calendly.com/event_types/b2330295-2a91-4a1d-bb73-99e7707663d5)

    - `call_retry_config: { calling_windows, max_retry_attempts, timezone}`

      Configuration for call retry behavior including time windows, delays, and max iterations. If not provided, defaults will be used.

      - `calling_windows: Array[{ calling_window_end_time, calling_window_start_time, retry_delay_seconds}]`

        - `calling_window_end_time: String`

          End time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '17:00', '6pm'. Default: '18:00'.

        - `calling_window_start_time: String`

          Start time for the calling window in the recipient's timezone (or timezone_override if provided). Format: 'HH:mm' (24-hour) or 'H:mma' (12-hour). Examples: '09:00', '10am'. Default: '10:00'.

        - `retry_delay_seconds: Integer`

          Delay between retry attempts in seconds. Default: 7200 (2 hours).

      - `max_retry_attempts: Integer`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: String`

        Optional IANA timezone identifier to override the automatic timezone detection from phone number. If not provided, timezone is determined from the recipient's phone number country code. Examples: 'America/New_York', 'Europe/Paris'.

    - `created_at: untyped`

    - `end_of_call_sentence: String`

    - `first_sentence: String`

    - `first_sentence_delay_ms: Integer`

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

    - `first_sentence_mode: :generated | :static | :none`

      - `:generated`

      - `:static`

      - `:none`

    - `ivr_navigation_enabled: bool`

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

    - `llm_model: { name, type} | { openrouter_model_id, openrouter_provider, type}`

      - `class UnionMember0`

        - `name: :"gpt-4.1" | :"ministral-3-8b-instruct"`

          - `:"gpt-4.1"`

          - `:"ministral-3-8b-instruct"`

        - `type: :"dedicated-instance"`

          - `:"dedicated-instance"`

      - `class UnionMember1`

        - `openrouter_model_id: String`

          The model ID to use from OpenRouter. eg: openai/gpt-4.1

        - `openrouter_provider: String`

          The provider to use from OpenRouter. eg: nebius, openai, azure, etc.

        - `type: :openrouter`

          Use a model from OpenRouter.

          - `:openrouter`

    - `max_call_duration_secs: Float`

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

    - `name: String`

    - `organization_id: String`

    - `prompt: String`

    - `structured_output_config: Array[{ name, required, type, 2 more}]`

      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.).

      - `name: String`

      - `required: bool`

      - `type: :string | :number | :boolean | 3 more`

        - `:string`

        - `:number`

        - `:boolean`

        - `:enum`

        - `:date`

        - `:datetime`

      - `description: String`

      - `enum_options: Array[String]`

    - `transfer_phone_number: String`

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

    - `updated_at: untyped`

    - `voice: { id, provider, speed}`

      - `id: String`

        The ID of the voice.

      - `provider: :cartesia | :elevenlabs`

        The provider of the voice.

        - `:cartesia`

        - `:elevenlabs`

      - `speed: Float`

        The speed of the voice. Range depends on provider: Cartesia 0.6–1.5, ElevenLabs 0.7–1.2. Default is 1.0.

    - `voicemail_message: String`

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

    - `webhook_url: String`

      The webhook URL to call when the call is completed.

    - `faq_items: Array[{ answer, question, id, 2 more}]`

      - `answer: String`

      - `question: String`

      - `id: String`

      - `needs_human_answer: bool`

      - `source: :human | :ai`

        - `:human`

        - `:ai`

    - `pending_faq_count: Float`

### Example

```ruby
require "revox"

revox = Revox::Client.new(api_key: "My API Key")

assistant = revox.assistants.update("id")

puts(assistant)
```

## Delete

`assistants.delete(id) -> AssistantDeleteResponse`

**delete** `/assistants/{id}`

Permanently delete an assistant by its ID. Any future calls referencing this assistant ID will fail. Existing call records that used this assistant are not affected.

### Parameters

- `id: String`

### Returns

- `class AssistantDeleteResponse`

  - `success: bool`

### Example

```ruby
require "revox"

revox = Revox::Client.new(api_key: "My API Key")

assistant = revox.assistants.delete("id")

puts(assistant)
```