## Clone

`assistants.clone(strid)  -> AssistantCloneResponse`

**post** `/assistants/{id}/clone`

Create a full copy of an existing assistant, including every configuration field and FAQ items. The new assistant has the same configuration as the source, with the name suffixed by "(Copy)" and a freshly generated API key.

### Parameters

- `id: str`

### Returns

- `class AssistantCloneResponse: …`

  - `assistant: Assistant`

    - `id: str`

    - `after_call_sms_outcomes: Optional[List[Literal["not_interested", "interested", "completed", 2 more]]]`

      Which call outcomes trigger the after-call SMS. When empty or null, no after-call SMS is sent. Use "none" when outcome is null.

      - `"not_interested"`

      - `"interested"`

      - `"completed"`

      - `"requested_callback_later"`

      - `"none"`

    - `after_call_sms_prompt: Optional[str]`

      Prompt / instructions for the after-call SMS. Supports {{variable}} placeholders. When null, no after-call SMS is sent.

    - `background_sound: Optional[Literal["audio/office.ogg"]]`

      Ambient background sound to play during the call. null disables it.

      - `"audio/office.ogg"`

    - `background_sound_volume: float`

      Volume of the ambient background sound (0 = silent, 1 = max).

    - `calendly: Optional[AssistantCalendly]`

      - `connection_id: str`

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

      - `event_type_id: str`

        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: Optional[AssistantCallRetryConfig]`

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

      - `allowed_days: List[Literal["monday", "tuesday", "wednesday", 4 more]]`

        Days of the week when calls are allowed, in the recipient's timezone. Default: Monday through Friday.

        - `"monday"`

        - `"tuesday"`

        - `"wednesday"`

        - `"thursday"`

        - `"friday"`

        - `"saturday"`

        - `"sunday"`

      - `call_twice_in_a_row: bool`

        If true and max_retry_attempts >= 2, attempt #2 fires immediately (skipping retry_delay_seconds) when attempt #1 didn't reach a human. Calling-window/allowed-days checks still apply. Only affects the 1→2 transition. Default: false.

      - `calling_windows: List[AssistantCallRetryConfigCallingWindow]`

        - `calling_window_end_time: str`

          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: str`

          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: int`

          Delay between retry attempts in seconds. 0 retries as soon as the calling window allows. Default: 7200 (2 hours).

      - `max_retry_attempts: int`

        Maximum number of call retry attempts. Default: 3.

      - `timezone: Optional[str]`

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

    - `cartesia_dictionary_pronunciation_id: Optional[str]`

      Optional Cartesia pronunciation dictionary ID linked to this assistant.

    - `created_at: object`

    - `custom_tools: Optional[List[AssistantCustomTool]]`

      - `body_template: Optional[str]`

        JSON body template for the request. Use quoted {{variable}} placeholders (e.g. "{{name}}") for dynamic values

      - `description: str`

        Human-readable description of what the tool does, used by the LLM to decide when to call it

      - `headers: List[AssistantCustomToolHeader]`

        HTTP headers to include in the request. Values support {{variable}} placeholders

        - `key: str`

        - `value: str`

      - `input_schema: List[AssistantCustomToolInputSchema]`

        Schema defining the parameters the LLM should extract from the conversation to pass to this tool

        - `name: str`

        - `required: bool`

        - `type: Literal["string", "number", "boolean", 3 more]`

          - `"string"`

          - `"number"`

          - `"boolean"`

          - `"enum"`

          - `"date"`

          - `"datetime"`

        - `description: Optional[str]`

        - `enum_options: Optional[List[str]]`

      - `method: Literal["GET", "POST", "PUT", 2 more]`

        HTTP method to use when calling the API endpoint

        - `"GET"`

        - `"POST"`

        - `"PUT"`

        - `"PATCH"`

        - `"DELETE"`

      - `name: str`

        Unique tool name in lowercase_snake_case (e.g. check_inventory)

      - `query_params: List[AssistantCustomToolQueryParam]`

        Query string parameters appended to the URL. Values support {{variable}} placeholders

        - `key: str`

        - `value: str`

      - `url: str`

        Full URL of the API endpoint. Supports {{variable}} placeholders for dynamic values

    - `email_notification_address: Optional[str]`

      Email address(es) to receive notifications when a call ends with a matching outcome. Accepts a single email or a comma-separated list (e.g. "alice@x.com, bob@y.com").

    - `email_notification_outcomes: Optional[List[Literal["not_interested", "interested", "completed", 2 more]]]`

      Which call outcomes trigger an email notification. E.g. ["interested", "completed", "none"]. Use "none" when outcome is null.

      - `"not_interested"`

      - `"interested"`

      - `"completed"`

      - `"requested_callback_later"`

      - `"none"`

    - `end_of_call_sentence: Optional[str]`

    - `first_sentence: Optional[str]`

    - `first_sentence_delay_ms: int`

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

    - `first_sentence_mode: Literal["generated", "static", "none"]`

      - `"generated"`

      - `"static"`

      - `"none"`

    - `from_phone_number: Optional[str]`

      Override the default outbound phone number for calls placed with this assistant. When null, the organization's default phone number is used.

    - `human_transfer_mode: Optional[Literal["warm", "cold"]]`

      Warm or cold transfer when transfer_phone_number is set; null when transfer is not configured.

      - `"warm"`

      - `"cold"`

    - `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: AssistantLlmModel`

      - `class AssistantLlmModelUnionMember0: …`

        - `name: Literal["gpt-4.1", "ministral-3-8b-instruct"]`

          - `"gpt-4.1"`

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

        - `type: Literal["dedicated-instance"]`

          - `"dedicated-instance"`

      - `class AssistantLlmModelUnionMember1: …`

        - `openrouter_model_id: str`

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

        - `openrouter_provider: str`

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

        - `type: Literal["openrouter"]`

          Use a model from OpenRouter.

          - `"openrouter"`

      - `class AssistantLlmModelUnionMember2: …`

        - `api_key: str`

          API key sent as Bearer token to the custom endpoint.

        - `api_url: str`

          Base URL for the OpenAI-compatible API, e.g. https://api.together.xyz/v1

        - `model_name: str`

          Model name as expected by the provider, e.g. meta-llama/llama-3-70b

        - `type: Literal["custom"]`

          OpenAI-compatible chat completions API (bring your own endpoint and key).

          - `"custom"`

      - `class AssistantLlmModelUnionMember3: …`

        - `provider: Literal["openai", "google"]`

          The provider to use from Realtime. eg: openai, google.

          - `"openai"`

          - `"google"`

        - `realtime_model_id: str`

          The model ID to use from Realtime. eg: gpt-4.1

        - `type: Literal["realtime"]`

          Use a model from Realtime.

          - `"realtime"`

        - `realtime_voice_id: Optional[str]`

          Output voice for the realtime provider (e.g. OpenAI: marin; Gemini: Puck).

    - `logo_url: Optional[str]`

      Public URL of the brand logo shown on the assistant's demo page. Null when unset.

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

    - `max_duration_end_message: Optional[str]`

      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.

    - `name: str`

    - `organization_id: str`

    - `position: Optional[AssistantPosition]`

      - `x: float`

      - `y: float`

    - `prompt: str`

    - `prompt_flow: Optional[AssistantPromptFlow]`

      - `edges: List[AssistantPromptFlowEdge]`

        - `id: str`

        - `source: str`

        - `target: str`

      - `nodes: List[AssistantPromptFlowNode]`

        - `id: str`

        - `data: AssistantPromptFlowNodeData`

          - `body: str`

          - `title: str`

        - `position: AssistantPromptFlowNodePosition`

          - `x: float`

          - `y: float`

        - `type: Literal["promptBlock"]`

          - `"promptBlock"`

    - `slack: Optional[AssistantSlack]`

      - `channel_id: str`

        The Slack channel ID where the notification will be posted.

      - `connection_id: str`

        The Nango connection ID linking the org's Slack workspace to Revox.

      - `outcomes: List[Literal["not_interested", "interested", "completed", 2 more]]`

        Which call outcomes trigger a Slack notification (e.g. ['interested', 'none']). Use 'none' to notify when outcome is null.

        - `"not_interested"`

        - `"interested"`

        - `"completed"`

        - `"requested_callback_later"`

        - `"none"`

      - `channel_name: Optional[str]`

        Human-readable Slack channel name, cached for display in the UI.

      - `template: Optional[str]`

        Optional message template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{first_name}}, {{last_name}}, {{email}}, {{company}}, {{job_title}}, {{contact_name}}, {{contact_line}}, plus prompt_variables and structured_output keys. When null/empty a default template is used.

    - `sms_enabled: bool`

      Enable SMS tool during calls. When enabled, the agent can send SMS messages to the user on the call.

    - `sms_template: Optional[str]`

      Hardcoded SMS template to send during calls. When set, this exact text is sent instead of letting the agent generate the message. Supports {{variable}} placeholders.

    - `structured_output_config: Optional[List[AssistantStructuredOutputConfig]]`

      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: str`

      - `required: bool`

      - `type: Literal["string", "number", "boolean", 3 more]`

        - `"string"`

        - `"number"`

        - `"boolean"`

        - `"enum"`

        - `"date"`

        - `"datetime"`

      - `description: Optional[str]`

      - `enum_options: Optional[List[str]]`

    - `structured_output_prompt: Optional[str]`

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

    - `stt_context: Optional[AssistantSttContext]`

      Assistant-level speech-to-text context: structured `general` key/value pairs plus a list of domain `terms`. Prompt-derived context is merged in without replacing existing entries.

      - `general: List[AssistantSttContextGeneral]`

        - `key: str`

        - `value: str`

      - `terms: List[str]`

    - `stt_model: Literal["stt-rt-v4", "stt-rt-v5"]`

      Transcriber (speech-to-text) model used for the assistant.

      - `"stt-rt-v4"`

      - `"stt-rt-v5"`

    - `thinking_sound: Optional[Literal["city-ambience.ogg", "forest-ambience.ogg", "office-ambience.ogg", 4 more]]`

      Audio clip to play while the agent is processing a response. One of the built-in LiveKit audio clips; null disables it.

      - `"city-ambience.ogg"`

      - `"forest-ambience.ogg"`

      - `"office-ambience.ogg"`

      - `"crowded-room.ogg"`

      - `"keyboard-typing.ogg"`

      - `"keyboard-typing2.ogg"`

      - `"hold_music.ogg"`

    - `thinking_sound_probability: float`

      Probability [0..1] that the thinking sound plays on any given turn; otherwise the agent is silent while thinking.

    - `thinking_sound_volume: float`

      Volume of the thinking sound (0 = silent, 1 = max).

    - `transfer_phone_number: Optional[str]`

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

    - `type: Literal["standalone", "multi-step", "sub-assistant"]`

      - `"standalone"`

      - `"multi-step"`

      - `"sub-assistant"`

    - `updated_at: object`

    - `voice: Optional[AssistantVoice]`

      - `id: str`

        The ID of the voice.

      - `provider: Literal["cartesia", "elevenlabs"]`

        The provider of the voice.

        - `"cartesia"`

        - `"elevenlabs"`

      - `model: Optional[Literal["sonic-3", "sonic-3.5"]]`

        Cartesia TTS model (Cartesia only). Defaults to sonic-3 when omitted. Ignored for other providers.

        - `"sonic-3"`

        - `"sonic-3.5"`

      - `speed: Optional[float]`

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

      - `volume: Optional[float]`

        Volume of the voice (Cartesia only). 0.5–2.0, default 1.0. Ignored for other providers.

    - `voicemail_message: Optional[str]`

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

    - `voicemail_sms_prompt: Optional[str]`

      Prompt / instructions for the voicemail SMS. Supports {{variable}} placeholders. When null, no SMS is sent on voicemail.

    - `warm_transfer_summary_instructions: Optional[str]`

      Warm transfer only: instructions for the supervisor handoff summary; null when not configured or cold transfer.

    - `webhook_url: Optional[str]`

      The webhook URL to call when the call is completed.

    - `zoho: Optional[AssistantZoho]`

      - `connection_id: str`

        The Nango connection ID linking the org's Zoho CRM account to Revox.

      - `field_mapping: List[AssistantZohoFieldMapping]`

        Maps extracted call fields (structured_output / prompt variables) onto Zoho field API names on the upserted record.

        - `source: str`

          Source key to read from the call: a structured_output field name, falling back to a prompt variable of the same name.

        - `zoho_field: str`

          Destination Zoho field API name on the upserted record (e.g. 'Email', 'Company', or a custom 'Budget__c').

      - `log_call_activity: bool`

        When true, also log the call as a record in Zoho's Calls module (related to the upserted prospect via Who_Id).

      - `module: str`

        Zoho module the prospect record is upserted into (e.g. 'Leads' or 'Contacts').

      - `outcomes: List[Literal["not_interested", "interested", "completed", 2 more]]`

        Which call outcomes trigger the Zoho push (e.g. ['interested', 'none']). Use 'none' to push when outcome is null.

        - `"not_interested"`

        - `"interested"`

        - `"completed"`

        - `"requested_callback_later"`

        - `"none"`

      - `template: Optional[str]`

        Optional Note body template. Supports {{summary}}, {{outcome}}, {{phone}}, {{call_url}}, {{assistant_name}}, {{campaign_name}}, {{transcript}}, plus prompt_variables and structured_output keys. When null/empty a default note (outcome + summary + auto-listed extracted fields) is used.

    - `created_by: Optional[AssistantCreatedBy]`

      The user who created the assistant.

      - `id: str`

        The database user id of the creator.

      - `email: str`

      - `first_name: Optional[str]`

      - `last_name: Optional[str]`

    - `faq_items: Optional[List[AssistantFaqItem]]`

      - `answer: str`

      - `question: str`

      - `id: Optional[str]`

      - `needs_human_answer: Optional[bool]`

      - `source: Optional[Literal["human", "ai"]]`

        - `"human"`

        - `"ai"`

    - `is_inbound_receptionist: Optional[bool]`

    - `is_realestate_assistant: Optional[bool]`

    - `pending_faq_count: Optional[float]`

### Example

```python
import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
response = client.assistants.clone(
    "id",
)
print(response.assistant)
```