API Reference

Powerful APIs for Developers

Build custom integrations, automate workflows, and extend your chatbot platform with our REST and GraphQL APIs. Comprehensive documentation, type-safe SDKs, and real-time streaming.

cURL

curl -X POST https://api.verbox.app/v1/chat \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"botId": "bot_abc123", "message": "Hello"}'

Two APIs

Choose Your Interface

Whether you prefer the simplicity of REST or the flexibility of GraphQL, Verbox has you covered with fully documented, production-ready APIs.

REST API

A straightforward RESTful interface for managing bots, sending messages, ingesting documents, and retrieving analytics. Standard HTTP methods, JSON payloads, and predictable resource URLs.

Full CRUD operations on bots, documents, and web sources
Chat completions with streaming support via Server-Sent Events
Analytics and usage metrics retrieval
Webhook management and delivery logs

Endpoints

POST/v1/chatSend a message

GET/v1/botsList all bots

POST/v1/documentsUpload document

GET/v1/analyticsFetch analytics

GraphQL API

A flexible, type-safe GraphQL schema for complex queries, nested relations, and real-time subscriptions. Request exactly the data you need in a single round trip.

Strongly typed schema with full introspection
Nested queries across bots, conversations, and users
Real-time subscriptions for live data updates
Filtering, sorting, and pagination built in

Endpoints

POST/api/graphqlQuery endpoint

WS/api/graphqlSubscriptions

GET/api/graphqlSchema introspection

POST/api/graphqlMutations

Capabilities

Built for Production

Everything you need to build reliable, secure, and scalable integrations with the Verbox platform.

Authentication

Secure API key authentication with scoped permissions. Generate, rotate, and revoke keys from your dashboard.

Rate Limiting

Generous rate limits with clear headers. Tiered limits based on your plan with automatic backoff guidance.

Webhooks

Real-time event notifications for chat messages, training completion, and subscription changes. HMAC-signed payloads.

SDKs

Official SDKs for Python and Node.js with full type definitions. Community libraries for Go, Ruby, and PHP.

Streaming

Server-Sent Events for real-time chat responses. Stream tokens as they are generated for low-latency interfaces.

Error Handling

Consistent error format with machine-readable codes, human-readable messages, and actionable resolution guidance.

Code Examples

Start Building in Minutes

Copy-paste these examples to get up and running. Every endpoint follows consistent patterns so you can move fast.

Create a Botbash

curl -X POST https://api.verbox.app/v1/bots \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Support Agent",
    "systemPrompt": "You are a helpful support agent.",
    "model": "gpt-4o",
    "temperature": 0.7
  }'

Send a Chat Messagepython

import requests

response = requests.post(
    "https://api.verbox.app/v1/chat",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
        "botId": "bot_abc123",
        "message": "How do I reset my password?",
        "stream": False,
    },
)

data = response.json()
print(data["reply"])

Fetch Analyticsjavascript

const response = await fetch(
  "https://api.verbox.app/v1/analytics?" +
    new URLSearchParams({
      botId: "bot_abc123",
      period: "30d",
      metrics: "messages,sessions,satisfaction",
    }),
  {
    headers: {
      Authorization: "Bearer YOUR_API_KEY",
    },
  }
);

const analytics = await response.json();
console.log(analytics.data);

Quick Start

Getting Started

Three steps to your first API call. No complex setup, no lengthy onboarding.

Create an Account

Sign up for a free Verbox account. No credit card required. You get immediate access to the API with generous free-tier limits.

Generate an API Key

Navigate to Settings, then API Keys in your dashboard. Create a new key with the scopes you need and store it securely.

Make Your First Request

Use the code examples above or our SDKs to send your first API call. Start with creating a bot and sending a test message.

Ready to Build?

Create a free account to get your API key and start integrating Verbox into your applications today. Full API access on every plan.

curl -X POST https://api.verbox.app/v1/bots \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "name": "Support Agent", "systemPrompt": "You are a helpful support agent.", "model": "gpt-4o", "temperature": 0.7 }'

import requests response = requests.post( "https://api.verbox.app/v1/chat", headers={ "Authorization": "Bearer YOUR_API_KEY", "Content-Type": "application/json", }, json={ "botId": "bot_abc123", "message": "How do I reset my password?", "stream": False, }, ) data = response.json() print(data["reply"])

const response = await fetch( "https://api.verbox.app/v1/analytics?" + new URLSearchParams({ botId: "bot_abc123", period: "30d", metrics: "messages,sessions,satisfaction", }), { headers: { Authorization: "Bearer YOUR_API_KEY", }, } ); const analytics = await response.json(); console.log(analytics.data);