bithuman-ai Providers API

openapi: 3.2.0
info:
  title: Bithuman Ai Providers 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 Providers 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: Providers
  description: 'Bring your own LLM, STT and TTS keys: https://docs.bithuman.ai/api/providers.'
paths:
  /v2/{user_id}/providers:
    parameters:
    - $ref: '#/components/parameters/UserId'
    get:
      operationId: getProviders
      x-codeSamples:
      - lang: shell
        label: cURL
        source: "curl \"https://api.bithuman.ai/v2/$USER_ID/providers\" \\\n  -H \"api-secret: $BITHUMAN_API_SECRET\"\n"
      summary: Get provider config
      description: 'Your configured provider keys (BYOK). Sensitive keys are returned only

        as `{present, hint, updated_at}`, never in full.'
      tags:
      - Providers
      responses:
        '200':
          description: The masked provider list.
          content:
            application/json:
              example:
                user_id: 3f9a…
                providers:
                  entries:
                  - id: b7e1…
                    platform: openai
                    label: OpenAI
                    options: {}
                    secrets:
                      apiKey:
                        present: true
                        hint: sk…4f2a
                        updated_at: '2026-07-02T09:30:00Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Account not found.
    put:
      operationId: updateProviders
      x-codeSamples:
      - lang: shell
        label: cURL
        source: "curl -X PUT \"https://api.bithuman.ai/v2/$USER_ID/providers\" \\\n  -H \"api-secret: $BITHUMAN_API_SECRET\" -H \"content-type: application/json\" \\\n  -d '{\"entries\":[{\"platform\":\"openai\",\"label\":\"OpenAI\",\"credentials\":{\"apiKey\":\"sk-…\"}}]}'\n"
      summary: Update provider config
      description: 'Replaces your provider list: `entries` is the **whole** list, and

        `{"entries": []}` clears every provider. Existing entries are matched by

        `id` and merged (unspecified credentials are kept); new entries get a

        generated id. Returns the same masked shape as `GET`.'
      tags:
      - Providers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - entries
              properties:
                entries:
                  type: array
                  items:
                    type: object
                    required:
                    - platform
                    properties:
                      platform:
                        type: string
                        description: Provider id, e.g. `openai`, `elevenlabs`, `cartesia`, `grok`.
                      id:
                        type: string
                        description: Existing entry id to update; omit to add a new one.
                      label:
                        type: string
                        description: Display name; defaults to the platform name.
                      credentials:
                        type: object
                        description: Key/value credentials. Sensitive keys are encrypted at rest.
                      options:
                        type: object
                        description: Per-capability configuration.
                      clearSecrets:
                        type: array
                        items:
                          type: string
                        description: Sensitive credential keys to remove.
                      metadata:
                        type: object
                        description: Freeform metadata.
      responses:
        '200':
          description: The stored list, masked as in `GET`.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          description: Account not found.
        '500':
          description: A storage failure.
    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
  parameters:
    UserId:
      name: user_id
      in: path
      required: true
      schema:
        type: string
      description: Your own account id, from `GET /v1/me` (`data.user_id`). Another account's id returns `403 FORBIDDEN`.
  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