> ## Documentation Index
> Fetch the complete documentation index at: https://docs.famulor.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Submit voice clone job

> Submits a prepared job after every sample upload finishes. Send either the preferred `id` returned by the upload-preparation endpoint or its transition alias `job_id`; if both are sent, they must match. Explicit rights confirmation is required. **Required scope:** `voices:write` or `assistants:write`. A user-bound credential is required.



## OpenAPI

````yaml /api-reference/openapi.json post /voices/clone
openapi: 3.1.0
info:
  title: Famulor API
  version: 1.0.0
  description: >-
    REST API for Famulor. Authenticate with an API key (`fam_...`, created under
    **Settings → API Keys**) or an OAuth 2.0 access token (`fam_at_...`) as a
    Bearer token.


    Every response uses a consistent envelope: `{ "data": ... , "meta": { ... }
    }` on success and `{ "error": { "code", "message" } }` on failure. List
    endpoints paginate with `?limit=` (default 50, max 200) and `?offset=`;
    `meta.pagination.total` carries the total match count.


    REST operations require API Access through the workspace plan or a recurring
    add-on. Without it, regular operations return `403 api_access_required`. The
    invoice-payment and billing-portal operations remain available with a valid
    credential after a failed plan payment so an owner can recover billing.


    The same customer-facing capabilities are available as MCP tools at
    `https://app.famulor.io/mcp` (Model Context Protocol, streamable HTTP) using
    the same credentials, scopes, and workspace access. MCP availability is
    controlled separately by Connect AI / MCP, not by API Access.
servers:
  - url: https://app.famulor.io/api/v1
    description: Hosted platform.
  - url: https://{domain}/api/v1
    description: White-label tenant domain — same paths, tenant branding.
    variables:
      domain:
        default: app.famulor.io
        description: Your white-label tenant domain.
security:
  - bearerAuth: []
tags:
  - name: Account
    description: Self-inspection of the calling credential.
  - name: Migrations
    description: Preview and import data from supported legacy platforms.
  - name: Assistants
    description: Create and manage voice assistants.
  - name: Tools
    description: >-
      Reusable tools (HTTP APIs and external MCP servers) assistants can call
      mid-conversation.
  - name: Voices
    description: Browse the text-to-speech voice library.
  - name: Calls
    description: Start outbound calls and read call history, transcripts and recordings.
  - name: History
    description: Unified conversation history across calls, messaging and assistant emails.
  - name: Campaigns
    description: Outbound calling campaigns with a compliant power dialer.
  - name: Leads
    description: Manage Audience contacts across campaigns, channels and Call QA metrics.
  - name: Segments
    description: >-
      Saved, dynamic lead filters — reusable audience definitions used for
      Audience search and campaign lead assignment.
  - name: Suppression
    description: Cross-channel marketing opt-outs and active workspace suppression records.
  - name: Callbacks
    description: >-
      Scheduled callbacks booked by the Schedule callback tool across voice,
      chat, and email.
  - name: Phone Numbers
    description: Marketplace numbers and customer-provided numbers.
  - name: Famulor Loop
    description: >-
      Personal business-phone access, directory, presence, devices, and Loop
      call recents.
  - name: SIP Trunks
    description: Bring your own SIP provider and numbers.
  - name: Carrier Connections
    description: Connect a supported carrier account and import its existing phone numbers.
  - name: Knowledge Bases
    description: RAG knowledge bases and documents for assistants.
  - name: Settings
    description: Workspace-level settings such as caller-memory defaults.
  - name: Billing
    description: Balance and minutes ledger of the key owner.
  - name: Automations
    description: >-
      Native workspace automations — list, create, update, trigger. Plan gate:
      automation_platform.
  - name: Milian Missions
    description: Recurring jobs that Milian runs unattended on schedule.
  - name: Integrations
    description: >-
      Calendar integrations (Cal.com, Calendly, Acuity Scheduling, Google
      Calendar, Outlook, native booking engine). Assign them to assistants to
      provide availability and booking tools, plus provider-supported
      appointment lookup, cancellation, and rescheduling.
  - name: Bookings
    description: >-
      Native booking engine — event types with weekly availability, public
      booking pages at /book/{workspace}/{slug}, and the bookings they produce.
  - name: Dashboards
    description: >-
      Custom analytics dashboards, reusable widgets, and tenant-scoped
      performance analytics. Requires the custom_dashboards plan feature.
  - name: Catalog
    description: >-
      Read-only platform catalogs — available models, supported assistant
      languages, and prompt templates.
  - name: Simulations
    description: Assistant simulation tests (plan-gated).
  - name: Versions
    description: Assistant configuration version history.
  - name: Caller IDs
    description: Outbound caller ID verification.
  - name: Widgets
    description: Web widget connectors.
  - name: Messaging
    description: >-
      Telegram, Slack, and Messenger text bots linked to assistants (Chat SDK).
      Includes conversation delay, inactivity end, and conversation-ended
      webhooks.
  - name: QA
    description: Cohort AI Quality Assurance runs over call transcripts.
  - name: White Label
    description: >-
      Manage the customers of your white-label workspace on their behalf — list,
      register, mint access tokens, log in, log out, and transfer credits.
      Available to reseller workspaces with white-label access, and to platform
      admins (scoped to direct platform customers). Requires `platform:read` /
      `platform:write`.
  - name: API Keys
    description: >-
      Self-service API keys for the calling workspace or a same-brand workspace
      where the credential's user is owner/admin. A key can only mint further
      keys with a scope subset of its own.
  - name: Workspaces
    description: >-
      List visible workspaces, create an additional workspace for the key owner,
      and mint a dedicated credential for a selected owner/admin workspace.
  - name: SMS
    description: Outbound SMS from workspace phone numbers.
paths:
  /voices/clone:
    post:
      tags:
        - Voices
      summary: Submit voice clone job
      description: >-
        Submits a prepared job after every sample upload finishes. Send either
        the preferred `id` returned by the upload-preparation endpoint or its
        transition alias `job_id`; if both are sent, they must match. Explicit
        rights confirmation is required. **Required scope:** `voices:write` or
        `assistants:write`. A user-bound credential is required.
      operationId: submitVoiceCloneJob
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - name
                - consent
              anyOf:
                - required:
                    - id
                - required:
                    - job_id
              properties:
                id:
                  type: string
                  format: uuid
                  description: >-
                    Opaque job ID returned by POST /voices/clone/uploads
                    (preferred).
                job_id:
                  type: string
                  format: uuid
                  description: Documented transition alias for `id`.
                name:
                  type: string
                  minLength: 1
                  maxLength: 80
                language:
                  type:
                    - string
                    - 'null'
                  minLength: 2
                  maxLength: 3
                consent:
                  type: boolean
                  const: true
                  description: Confirms that you have the right to clone this voice.
      responses:
        '202':
          description: Job accepted for durable processing.
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    required:
                      - job
                    properties:
                      job:
                        $ref: '#/components/schemas/VoiceCloneJob'
      security:
        - BearerAuth: []
components:
  schemas:
    VoiceCloneJob:
      type: object
      required:
        - id
        - operation
        - status
        - name
        - language
        - error_code
        - clone_id
        - created_at
        - updated_at
        - expires_at
      properties:
        id:
          type: string
          format: uuid
        operation:
          type: string
          enum:
            - create
            - delete
        status:
          type: string
          enum:
            - awaiting_upload
            - queued
            - processing
            - ready
            - failed
            - deleting
            - delete_failed
            - deleted
            - expired
        name:
          type:
            - string
            - 'null'
        language:
          type:
            - string
            - 'null'
        error_code:
          type:
            - string
            - 'null'
          description: Stable customer-facing failure code, when processing failed.
        clone_id:
          type:
            - string
            - 'null'
          format: uuid
          description: Opaque cloned-voice ID once creation is ready.
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        API key (`fam_...`, created under **Settings → API Keys**) or an OAuth
        2.0 access token (`fam_at_...`). REST operations also require API Access
        for the credential's workspace. Keys can be restricted to scopes such as
        `assistants:read`, `calls:write`, `campaigns:write`, `automations:read`,
        `dashboards:read`, `dashboards:write`, `leads:write`, `segments:write`,
        `loop:read`, `loop:write`, `phone_numbers:write`, `sip_trunks:write`,
        `knowledge:write`, `voices:read`, `billing:read`, `settings:write`,
        `platform:read`, `platform:write`; a `*:write` scope implies the
        matching `*:read`. Automation and dashboard endpoints also accept the
        legacy `calls:*` scope. Keys without scope restrictions have full access
        within the workspace's available capabilities.

````