API Overview - ToeBox Documentation

The ToeBox API lets you interact with your agents, chatbots, and analytics programmatically. Use it to send messages, manage agent configurations, and retrieve widget settings.

Base URL

All API requests are made to your ToeBox instance:

https://your-store.toebox.ai/api

Replace your-store with your ToeBox subdomain (usually your Shopify shop name without .myshopify.com).

Authentication

All API endpoints require authentication using your ToeBox API key. Include it as a Bearer token in the Authorization header:

curl -X GET https://your-store.toebox.ai/api/agents \
  -H "Authorization: Bearer tb_your-api-key"

Find your API key in Settings > API Keys within the ToeBox dashboard.

Keep your API key secret. Do not expose it in client-side code, public repositories, or browser-accessible files.

Response format

All responses are returned as JSON. Successful responses include the data directly:

{
  "agents": [
    {
      "id": "agent_abc123",
      "name": "Support Bot",
      "type": "customer_support",
      "status": "active"
    }
  ]
}

Error responses include an error field:

{
  "error": "Invalid API key",
  "status": 401
}

Rate limits

API rate limits depend on your plan:

Plan	Requests per minute
Free	20
Starter	60
Pro	200
Enterprise	Custom

Rate-limited requests return a 429 Too Many Requests status code with a Retry-After header.

Available endpoints

Chat

Send messages to your agents and receive streaming responses.

Agents

List and create agent configurations.

Widget Config

Retrieve chatbot widget configuration for embedding.

Authentication

Learn how to authenticate and manage API keys.

​Base URL

​Authentication

​Response format

​Rate limits

​Available endpoints

Chat

Agents

Widget Config

Authentication

Base URL

Authentication

Response format

Rate limits

Available endpoints