bithuman-ai

bithuman-ai Status API

Is the API currently refusing work? Unauthenticated, always HTTP 200 — read the `status` field. For a fleet-wide view use [status.bithuman.ai](https://status.bithuman.ai).

Documentation GitHub OpenAPI

Operations 1

GET /readyz API readiness #

Specifications

⚙

OpenAPI

https://artifacts.apis.io/bithuman-ai/openapi/bithuman-ai-status-api-openapi.yml

Schemas & Data

📊

JSONSchema

https://artifacts.apis.io/bithuman-ai/json-schema/bithuman-ai-agent-schema.json

📊

JSONSchema

https://artifacts.apis.io/bithuman-ai/json-schema/bithuman-ai-agent-list-item-schema.json

📊

JSONSchema

https://artifacts.apis.io/bithuman-ai/json-schema/bithuman-ai-usage-event-schema.json

📊

JSONSchema

https://artifacts.apis.io/bithuman-ai/json-schema/bithuman-ai-provider-selection-schema.json

📊

JSONSchema

https://artifacts.apis.io/bithuman-ai/json-schema/bithuman-ai-webhook-schema.json

📊

JSONSchema

https://artifacts.apis.io/bithuman-ai/json-schema/bithuman-ai-webhook-delivery-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/bithuman-ai:bithuman-ai-status-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Bithuman Ai Status 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 Status 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: Status
  description: 'Is the API currently refusing work? Unauthenticated, always HTTP 200 —

    read the `status` field. For a fleet-wide view use

    status.bithuman.ai.'
paths:
  /readyz:
    get:
      operationId: getReadiness
      x-codeSamples:
      - lang: shell
        label: cURL
        source: 'curl https://api.bithuman.ai/readyz

          # → {"status":"ok","families":{"sessions":{"status":"ok"}, ...}}

          '
      summary: API readiness
      description: 'Whether the API is refusing work right now. No credential required.

        It always answers HTTP 200: read the `status` field (`ok`, `degraded`

        or `unhealthy`). For the overall service status, use

        status.bithuman.ai.'
      tags:
      - Status
      security: []
      responses:
        '200':
          description: The readiness verdict.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - ok
                    - degraded
                    - unhealthy
                  window_seconds:
                    type: number
                    example: 900
                  observed_seconds:
                    type: number
                  replica_scope:
                    type: string
                    example: this process only — not a fleet view
                  families:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        status:
                          type: string
                          enum:
                          - ok
                          - degraded
                          - unhealthy
    servers:
    - url: https://api.bithuman.ai
      description: Production
components:
  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