Self-docs

Returns the full OpenAPI specification of the Bot API. Use this for LLM integration, code generation, and API exploration.

What you get

A complete OpenAPI 3.0 JSON spec describing every Bot API endpoint, request/response schemas, authentication requirements, and error codes.

Example request

curl https://app.bx-livechat.com/api/bot/docs \
  -H "Authorization: Bearer bxl_pat_aB7XyZ..."

Integration examples

Feed to ChatGPT / Claude

Download the spec and include it in your system prompt. The LLM can then generate correct API calls, validate parameters, and handle errors without separate documentation.

Generate TypeScript SDK

# Save the spec locally
curl https://app.bx-livechat.com/api/bot/docs \
  -H "Authorization: Bearer bxl_pat_aB7XyZ..." \
  -o bxlivechat-spec.json

# Generate a typed client
npx openapi-typescript-codegen \
  --input bxlivechat-spec.json \
  --output ./src/generated/bxlivechat \
  --client axios

Import to Postman

In Postman, go to Import → Link and paste the endpoint URL. Postman will create a full collection with all endpoints, example bodies, and auth headers pre-configured.