Call2Me Voices API

openapi: 3.2.0
info:
  title: Call2Me Voices API
  description: '# Call2Me Voice AI Platform API


    Programmatic interface to build, deploy and operate voice AI agents that can place

    and receive phone calls in real time. Designed to be consumed by humans **and** by

    AI agent frameworks (function-calling LLMs, MCP servers, automation platforms like

    Composio, Pipedream, Zapier, n8n).


    ## What you can do


    - **Place outbound calls** — give an agent a phone number to dial; the AI handles

    the conversation end-to-end and returns a transcript + recording.

    - **Manage AI agents** — create personalities, attach voices, system prompts,

    knowledge bases and post-call actions.

    - **Schedule calls** — one-shot or recurring (cron-like) outbound calls.

    - **Knowledge base (RAG)** — upload documents/URLs so the agent answers from your

    data with reduced hallucination.

    - **Inbound** — provision phone numbers that route to your agents.


    ## Common LLM tool-calling use cases


    | Goal | Endpoint |

    |------|----------|

    | "Call this person and read them this script" | `POST /v1/calls` |

    | "Schedule a follow-up tomorrow at 14:00" | `POST /v1/schedules` |

    | "Get the transcript of last call" | `GET /v1/calls/{id}` |

    | "Add this PDF to the agent''s brain" | `POST /v1/knowledge-base/{id}/sources` |


    ## Authentication


    Every request requires a Bearer token issued from the dashboard:


    ```

    Authorization: Bearer c2m_sk_xxxxxxxxxxxxxxxx

    ```


    Get your API key from the API Keys page.

    Keys are scoped per-workspace and can be rotated/revoked any time.


    ## Rate Limits


    | Plan | Requests/min | Concurrent Calls |

    |------|-------------|------------------|

    | Free | 60 | 1 |

    | Pro | 600 | 10 |

    | Enterprise | Unlimited | Unlimited |


    ## SDKs & Integrations


    - Python SDK

    - Node.js SDK

    - OpenAPI 3.1 spec: `/openapi.json` (use it to generate clients or register the

    service with AI tool platforms)


    ## Support


    - Email: support@call2me.app

    - Docs: https://docs.call2me.app

    - Discord: https://discord.gg/call2me'
  version: 1.0.0
  x-logo:
    url: https://call2me.app/logo.png
    altText: Call2Me Logo
  contact:
    name: Call2Me Support
    url: https://call2me.app/support
    email: support@call2me.app
  license:
    name: Commercial — see Terms of Service
    url: https://call2me.app/terms
  termsOfService: https://call2me.app/terms
servers:
- url: https://api.call2me.app
  description: Production
- url: http://localhost:8000
  description: Local Development
security:
- BearerAuth: []
tags:
- name: Voices
  description: Browse available TTS voices from OpenAI, ElevenLabs, Cartesia and MiniMax. Filter by language, gender or provider; preview audio samples; reference a voice's `voice_id` when creating an agent.
paths:
  /v1/voices:
    get:
      tags:
      - Voices
      summary: List Voices
      description: 'List available voices.


        Filter by language, provider, or gender. Multilingual voices match any language filter.'
      operationId: list_voices_v1_voices_get
      parameters:
      - name: language
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by language code
          title: Language
        description: Filter by language code
      - name: provider
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by provider
          title: Provider
        description: Filter by provider
      - name: gender
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter by gender
          title: Gender
        description: Filter by gender
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Voice'
                title: Response List Voices V1 Voices Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/voices/{voice_id}:
    get:
      tags:
      - Voices
      summary: Get Voice
      description: 'Get voice details.


        Returns full voice information including provider and language support.'
      operationId: get_voice_v1_voices__voice_id__get
      parameters:
      - name: voice_id
        in: path
        required: true
        schema:
          type: string
          title: Voice Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Voice'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/voices/{voice_id}/preview.mp3:
    get:
      tags:
      - Voices
      summary: Preview Voice Static
      description: 'Herkese açık, YALNIZ önbellekten servis eder (üretmez → maliyet/istismar yok).


        Önbellekte yoksa 404; istemci POST /preview''a düşer.'
      operationId: preview_voice_static_v1_voices__voice_id__preview_mp3_get
      parameters:
      - name: voice_id
        in: path
        required: true
        schema:
          type: string
          title: Voice Id
      - name: language
        in: query
        required: false
        schema:
          type: string
          default: tr-TR
          title: Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/voices/{voice_id}/preview:
    post:
      tags:
      - Voices
      summary: Preview Voice
      description: 'Ses önizlemesi (kimlik gerekir). Önce R2 önbelleği, yoksa üretip kaydeder.


        Yalnız voices.json''daki ses + sabit dil cümlesi.'
      operationId: preview_voice_v1_voices__voice_id__preview_post
      parameters:
      - name: voice_id
        in: path
        required: true
        schema:
          type: string
          title: Voice Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    Voice:
      properties:
        voice_id:
          type: string
          title: Voice Id
          description: Unique identifier in format 'provider-name'
          examples:
          - openai-nova
          - azure-tr-emel
        name:
          type: string
          title: Name
          description: Human-readable voice name
          examples:
          - Nova
          - Emel
        provider:
          type: string
          enum:
          - elevenlabs
          - cartesia
          - deepgram
          - openai-realtime
          title: Provider
          description: TTS provider
        language:
          type: string
          title: Language
          description: Primary language or 'multilingual'
          examples:
          - tr-TR
          - en-US
          - multilingual
        gender:
          type: string
          enum:
          - male
          - female
          - neutral
          title: Gender
          description: Voice gender
        description:
          anyOf:
          - type: string
          - type: 'null'
          title: Description
          description: Voice characteristics description
        preview_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Preview Url
          description: URL to sample audio
        supported_languages:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Supported Languages
          description: List of supported language codes
        provider_voice_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Provider Voice Id
          description: Real provider voice ID (ElevenLabs/Google) used for TTS
        model:
          anyOf:
          - type: string
          - type: 'null'
          title: Model
          description: TTS model for this voice (e.g. eleven_flash_v2_5)
      type: object
      required:
      - voice_id
      - name
      - provider
      - language
      - gender
      title: Voice
      description: Voice configuration for TTS.
    PreviewRequest:
      properties:
        language:
          type: string
          title: Language
          default: tr-TR
        text:
          anyOf:
          - type: string
          - type: 'null'
          title: Text
      type: object
      title: PreviewRequest
      description: 'Request model for voice preview. `text` YOK SAYILIR: keyfi metin kabul

        etmek bizim paramızla TTS yaptırmaktır (kota istismarı); sabit cümle kullanılır.'
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: Enter your API key
externalDocs:
  description: Full developer documentation
  url: https://docs.call2me.app