Skip to main content
The OpenBat API lets you ingest conversation data from your chatbot and retrieve analytics through a set of REST endpoints. All endpoints share a single base URL and fall into two authentication categories.

Base URL

https://app.openbat.dev

Endpoint categories

SDK ingestion API

Authenticated with an API key (ob_live_...), passed as a Bearer token. Use this from your chatbot integration to send conversation data to OpenBat.
Authorization: Bearer ob_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4

Dashboard API

Authenticated with a Supabase session cookie, established through the web login flow. These endpoints power the OpenBat dashboard and are available for programmatic access. All dashboard endpoints enforce organization-level row-level security — you can only access data that belongs to your organization.

API key format

ob_live_<32 lowercase hex characters>

Example: ob_live_a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4
The prefix ob_live_a1b2c3 (roughly the first 14 characters) is stored in the dashboard for identification. The full key is hashed with SHA-256 before storage — only the hash is persisted. The full key is returned once at creation or rotation and cannot be recovered.

Rate limits and constraints

EndpointLimit
POST /api/v1/capture1-100 messages per request
GET /api/v1/conversationsMax page size: 100
GET /api/v1/analytics/sentimentMax lookback: 365 days

Endpoint overview

EndpointMethodAuthDescription
/api/v1/capturePOSTAPI KeyIngest conversation messages
/api/v1/chatbotsGETSessionList chatbots
/api/v1/chatbotsPOSTSessionCreate chatbot
/api/v1/chatbots/:idGETSessionGet chatbot
/api/v1/chatbots/:idPATCHSessionUpdate chatbot
/api/v1/chatbots/:idDELETESessionDelete chatbot
/api/v1/chatbots/:id/rotate-keyPOSTSessionRotate API key
/api/v1/conversationsGETSessionList conversations
/api/v1/conversations/:idGETSessionGet conversation detail
/api/v1/analytics/overviewGETSessionAggregate metrics
/api/v1/analytics/sentimentGETSessionSentiment trends