bithuman-ai Realtime API

openapi: 3.2.0
info:
  title: Bithuman Ai Realtime API
  version: '1.0'
  contact:
    name: bitHuman Support
    url: https://www.bithuman.ai/discord
  x-logo:
    url: https://docs.bithuman.ai/bithuman-mark.png
  description: 'Operations tagged Realtime across 2 of this provider''s published API definitions: openapi.yaml, bithuman-ai-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.bithuman.ai
  description: Production
security:
- apiSecret: []
tags:
- name: Realtime
  description: OpenAI Realtime voice through bitHuman; the WebSocket relay is on https://docs.bithuman.ai/api/realtime.
paths:
  /v1/realtime/connect:
    post:
      operationId: realtimeConnect
      x-codeSamples:
      - lang: shell
        label: cURL
        source: "curl -X POST https://api.bithuman.ai/v1/realtime/connect \\\n  -H \"api-secret: $BITHUMAN_API_SECRET\" -H \"content-type: application/json\" \\\n  -d '{\"action\": \"hangup\", \"call\": \"<X-Bithuman-Call>\"}'\n"
      summary: Start or end a WebRTC Realtime call
      description: 'Starts a WebRTC voice call: send the SDP offer as the body

        (`Content-Type: application/sdp`) with `?model=gpt-realtime-mini`; a

        `201` carries the SDP answer, and the `X-Bithuman-Call` header names

        the call. End it with a JSON body `{"action": "hangup", "call": …}` —

        billing stops when you hang up. See

        Realtime.'
      tags:
      - Realtime
      parameters:
      - name: model
        in: query
        schema:
          type: string
          example: gpt-realtime-mini
        description: The Realtime model, fixed for the call.
      requestBody:
        required: true
        content:
          application/sdp:
            schema:
              type: string
              description: The SDP offer.
          application/json:
            schema:
              type: object
              properties:
                action:
                  type: string
                  enum:
                  - hangup
                call:
                  type: string
                  description: The `X-Bithuman-Call` value from the start.
      responses:
        '201':
          description: The SDP answer (`application/sdp`).
        '401':
          $ref: '#/components/responses/Unauthorized'
    servers:
    - url: https://api.bithuman.ai
      description: Production
components:
  responses:
    Unauthorized:
      description: 'Authentication failed. `UNAUTHORIZED` when the `api-secret` header is

        present but invalid; `MISSING_AUTH` when it is absent. The HTTP status

        equals `status_code` (401).

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Invalid API secret
              httpStatus: 401
            status: error
            status_code: 401
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              example: UNAUTHORIZED
            message:
              type: string
              example: Invalid API secret
            httpStatus:
              type: integer
              example: 401
            upgrade_url:
              type: string
              description: 'On `PLAN_REQUIRED`, `AGENT_LIMIT_REACHED` and `CONCURRENCY_LIMIT_REACHED` (403): where to choose a plan. Send the user there instead of retrying. See [Plan and credit refusals](https://docs.bithuman.ai/api/errors#plan-and-credit-refusals).'
              example: https://www.bithuman.ai/pricing
            topup_url:
              type: string
              description: 'On `INSUFFICIENT_BALANCE` (402): where to top up credits.'
              example: https://www.bithuman.ai/billing#credits
            details:
              type: object
              description: Code-specific fields. `CONCURRENCY_LIMIT_REACHED` sends `tier`, `cap`, `active` and `upgrade_url`.
              additionalProperties: true
        status:
          type: string
          example: error
        status_code:
          type: integer
          example: 401
  securitySchemes:
    apiSecret:
      type: apiKey
      name: api-secret
      in: header
      description: 'Your bitHuman API secret. Get one at

        [www.bithuman.ai/developer/api-keys](https://www.bithuman.ai/developer/api-keys).

        '
    bearerApiSecret:
      type: http
      scheme: bearer
      description: 'The same API secret, sent as `Authorization: Bearer <api-secret>`. Self-

        hosted runtimes send it this way; the classic `api-secret` header works

        on the same routes.

        '
x-refined-from:
- openapi.yaml
- bithuman-ai-openapi.yaml
x-tagGroups:
- name: Get started
  tags:
  - overview
  - quickstart
  - auth-guide
  - models
  - pricing
- name: Core concepts
  tags:
  - avatars-imx
  - audio-streaming
  - agent-lifecycle
- name: SDKs
  tags:
  - sdk-python
  - sdk-swift
  - cli
- name: Guides
  tags:
  - local-mode
  - building-avatars
- name: Deployment
  tags:
  - deploy-livekit
  - deploy-self-hosted
  - deploy-embed
- name: API reference
  tags:
  - Authentication
  - Agent Generation
  - Agent Management
  - Agent Context
  - Files
  - Dynamics
  - Embedding
  - Video
  - Billing
  - Account
  - Self-hosting
  - API secrets
  - Providers
  - Runtime sessions
  - Knowledge
  - Realtime
  - Status
  - Webhooks
- name: Resources
  tags:
  - community
  - changelog
  - support