Skip to main content

API Reference

The Bothive REST API gives you programmatic control over every agent. Call agents from any backend, any language.

Base URL

Authentication

All API requests require a Bothive API key:
Get your API key from: bothive.cloud/dashboard/settings/api
Never expose your API key in client-side code, public repos, or browser environments. Always call the Bothive API from your server or backend.

Core endpoints

POST /v1/bots/:id/chat

Send a message to an agent. Supports streaming via SSE. Maintains session context via X-Session-ID header.

POST /v1/bots/:id/execute

Execute an agent with a prompt — stateless, no session context. Useful for one-shot tasks and background jobs.

POST /v1/bots/:id/deploy

Deploy a HiveLang file to a bot programmatically. CI/CD-ready.

GET /v1/bots/:id/runs

List all runs for a bot. Filter by user, status, date, or channel. Returns traces.

Rate limits

Rate limit headers are returned on every response:

Error codes

All error responses follow this format:

SDK availability

Official SDKs:

API Playground

Try the API directly in your browser at bothive.cloud/api-playground. The playground lets you:
  • Make live API calls with your real API key
  • Test different bot IDs and session IDs
  • Inspect request and response payloads
  • Copy curl commands

Next reads

Chat API

Execute API

Deploy API