bithuman-ai Dynamics API

openapi: 3.2.0
info:
  title: Bithuman Ai Dynamics 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 Dynamics 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: Dynamics
  description: 'Generate and manage conversational gesture animations (wave,

    nod, laugh, idle motions) for an avatar. Generate them

    asynchronously, then toggle on/off to make them the active model

    for live sessions. Gestures trigger based on keyword mapping

    during conversation.'
paths:
  /v1/dynamics/generate:
    post:
      operationId: generateDynamics
      x-codeSamples:
      - lang: shell
        label: cURL
        source: "curl -X POST https://api.bithuman.ai/v1/dynamics/generate \\\n  -H \"api-secret: $BITHUMAN_API_SECRET\" \\\n  -H \"content-type: application/json\" \\\n  -d '{\"agent_id\": \"A95SXN5716\"}'\n# → {\"success\": true, \"status\": \"processing\"} — poll GET /v1/dynamics/A95SXN5716\n"
      summary: Generate gesture animations
      description: 'Create gesture animations (wave, nod, smile, laugh, etc.) for an agent.

        These can be triggered during live sessions via keyword mapping.'
      tags:
      - Dynamics
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          type: string
        description: Optional. A unique client-generated key (e.g. a UUID). Retrying with the same key returns the original response instead of starting a second billed job. Keys are retained for 24 hours.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - agent_id
              properties:
                agent_id:
                  type: string
                  example: A95SXN5716
                image_url:
                  type: string
                  description: Source image URL. Optional — defaults to the agent's primary image if omitted.
                duration:
                  type: integer
                  default: 5
                  description: Gesture duration in seconds.
                model:
                  type: string
                  enum:
                  - seedance
                  - auto
                  default: seedance
                  description: Video motion model. `seedance` (Seedance 1.5 pro) is the only dynamics model; `auto` resolves to it. Any legacy value (e.g. the retired `kling`) is coerced to `seedance`.
      responses:
        '200':
          description: Dynamics generation started
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                    example: Dynamics generation started
                  agent_id:
                    type: string
                  status:
                    type: string
                    example: processing
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          description: Insufficient credits. Dynamics generation costs 250 credits — INSUFFICIENT_BALANCE.
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://api.bithuman.ai
      description: Production
  /v1/dynamics/{agent_id}:
    get:
      operationId: getDynamics
      x-codeSamples:
      - lang: shell
        label: cURL
        source: "curl https://api.bithuman.ai/v1/dynamics/A95SXN5716 \\\n  -H \"api-secret: $BITHUMAN_API_SECRET\"\n"
      summary: Get available gestures
      description: List all available gesture animations for an agent.
      tags:
      - Dynamics
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
        example: A95SXN5716
      responses:
        '200':
          description: Available gestures
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: object
                    properties:
                      agent_id:
                        type: string
                      url:
                        type: string
                        description: Model path or null.
                      status:
                        type: string
                        enum:
                        - ready
                        - generating
                        - processing
                        - failed
                      gestures:
                        type: object
                        description: Map of gesture name to video URL.
                        additionalProperties:
                          type: string
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
    put:
      operationId: updateDynamics
      x-codeSamples:
      - lang: shell
        label: cURL
        source: "curl -X PUT https://api.bithuman.ai/v1/dynamics/A95SXN5716 \\\n  -H \"api-secret: $BITHUMAN_API_SECRET\" \\\n  -H \"content-type: application/json\" \\\n  -d '{\"dynamics\": {\"enabled\": true}, \"toggle_enabled\": true}'\n"
      summary: Update dynamics configuration
      description: 'Update gesture settings for an agent. After a successful update,

        movements regeneration is automatically triggered in the background.'
      tags:
      - Dynamics
      parameters:
      - name: agent_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - dynamics
              properties:
                dynamics:
                  type: object
                  description: 'Dynamics configuration to merge with existing data.

                    Fields: `enabled` (boolean), `batch_results` (gesture results),

                    `result` (model path/hash when generated), `talking` (default model path/hash).

                    '
                  properties:
                    enabled:
                      type: boolean
                      description: Enable or disable dynamics for this agent.
                    batch_results:
                      type: object
                      description: Map of gesture names to video generation results.
                    result:
                      type: object
                      description: Result model path and hash (set when dynamics generation completes).
                    talking:
                      type: object
                      description: Default talking model path and hash (used when dynamics are disabled).
                toggle_enabled:
                  type: boolean
                  description: '`true` to switch agent to dynamics model, `false` to restore default talking model.

                    '
      responses:
        '200':
          description: Dynamics updated and movements regeneration triggered
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    type: string
                    example: Dynamics updated successfully and movements regeneration started
                  agent_id:
                    type: string
                  regeneration_status:
                    type: string
                    enum:
                    - started
                    - failed
                    description: Whether background movements regeneration was triggered.
                  regeneration_error:
                    type: string
                    description: Error message if regeneration_status is "failed".
        '429':
          $ref: '#/components/responses/RateLimited'
    servers:
    - url: https://api.bithuman.ai
      description: Production
components:
  responses:
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: NOT_FOUND
              message: Agent not found
              httpStatus: 404
            status: error
            status_code: 404
    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
    RateLimited:
      description: 'Too many requests. The limiter is **per account** — every API secret on

        the account draws from one bucket — and **per cost tier**, so a burst of

        reads never uses up your generate budget. Your plan sets the number for

        each tier; the matrix, the tier each route belongs to and a retry

        recipe are on

        [Rate limits](https://docs.bithuman.ai/api/rate-limits).


        Wait `Retry-After` seconds and retry. The `X-RateLimit-*` headers let a

        client slow down *before* it gets here, but header coverage is uneven

        across routes — read them defensively and fall back to exponential

        backoff when they are absent.


        On a route that can also be called without an API secret, an anonymous

        call is metered per network address instead: same body, same

        `Retry-After`, no `X-RateLimit-*`.

        '
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait before retrying.
          example: 1
        X-RateLimit-Limit:
          schema:
            type: integer
          description: Requests per minute your plan allows on this request's cost tier.
          example: 30
        X-RateLimit-Remaining:
          schema:
            type: integer
          description: Whole requests left in the bucket right now.
          example: 0
        X-RateLimit-Reset:
          schema:
            type: integer
          description: Unix time at which the bucket is fully refilled.
          example: 1758380460
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: RATE_LIMITED
              message: Too many generate requests for this api-secret. Retry in ~1s.
              httpStatus: 429
            status: error
            status_code: 429
  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