API Reference

The 8bit-ai REST API provides programmatic access to the entire platform — agents, conversations, messages, webhooks, billing, and organization management. All API endpoints return structured JSON responses.

app.8bit-ai.com

Base URL

All API requests should be made to: https://api.8bit-ai.com/v1

API Overview

The API follows RESTful conventions with resource-oriented URLs. All requests must include a valid access token in the Authorization header. Responses include standard HTTP status codes and a consistent JSON envelope.

Response Envelope

All successful responses use a standard envelope with success anddata fields. Error responses include error with a code and message.

Example Request

Authentication

All API requests require authentication using a Bearer token in the Authorization header. Access tokens are obtained via the authentication endpoints.

Tokens are JWT-based with a 15-minute expiration. Use the refresh token endpoint to obtain a new access token without requiring the user to re-authenticate.

Token Security

Never expose access tokens in client-side code, URLs, or logs. Store tokens securely using environment variables or a secrets management service.

API Key Alternative

For server-to-server integrations, you can use API keys instead of user tokens. API keys are long-lived credentials that can be scoped to specific permissions.

Rate Limits

API requests are rate-limited per organization to ensure fair usage and platform stability. Rate limits vary by plan tier.

Plan	Requests per Minute	Burst Limit
Starter	60	100
Pro	600	1,000
Enterprise	Custom	Custom

Rate Limit Headers

Rate limit status is included in response headers:

Header	Description
X-RateLimit-Limit	Maximum requests allowed per minute
X-RateLimit-Remaining	Requests remaining in the current window
X-RateLimit-Reset	Unix timestamp when the rate limit resets

Rate Limit Handling

When you exceed the rate limit, the API returns a 429 Too Many Requests response. Implement exponential backoff and respect the Retry-After header.

Error Codes

The API uses standard HTTP status codes and returns detailed error information in the response body.

Status	Code	Description
400	INVALID_REQUEST	Malformed request body or missing required fields
401	UNAUTHORIZED	Missing or invalid authentication token
403	FORBIDDEN	Insufficient permissions for the requested action
404	NOT_FOUND	The requested resource does not exist
409	CONFLICT	Resource conflict (e.g., duplicate name)
429	RATE_LIMITED	Too many requests, rate limit exceeded
500	INTERNAL_ERROR	Unexpected server error. Contact support if persistent.

Error Response Format

Error responses always include a code and message. Some errors may include adetails object with additional context about the error.

Pagination

List endpoints use cursor-based pagination to efficiently navigate through large result sets. Pagination parameters are passed as query string parameters.

Pagination Parameters

Parameter	Type	Description
limit	integer	Number of results per page (default: 20, max: 100)
cursor	string	Cursor from the previous response for the next page
order	string	Sort order: `asc` or `desc` (default: desc)

Paginated Response

Pagination Example

Explore more API documentation.

Authentication Webhooks Agents