Getting Started

Overview

The Conversation Engine Developer API lets you programmatically manage every aspect of your chatbot workspace - create and configure chatbots, design conversation flows, attach knowledge bases, manage integrations, and pull analytics.

The APIs are rate limited with about average of

• Reads: 1 Request/seconds
• Write/Update: 1 Request/ 2 Seconds

Just be reasonable with usage, we can assume you are just not hitting Enter out of panic...

All endpoints are organized under:

http://localhost:3000/api/dev/v1http://localhost:3000/api/dev/v1

The API follows REST conventions - resources are accessed via standard HTTP methods, request and response bodies are JSON, and errors return meaningful HTTP status codes.

Quick Start

Get your workspace info in 30 seconds:

curl -X GET http://localhost:3000/api/dev/v1/me \
  -H "Authorization: Bearer <your-api-key>"curl -X GET http://localhost:3000/api/dev/v1/me \
  -H "Authorization: Bearer <your-api-key>"

import requests
response = requests.get(
    "http://localhost:3000/api/dev/v1/me",
    headers={"Authorization": "Bearer <your-api-key>"},
)
print(response.json())import requests
response = requests.get(
    "http://localhost:3000/api/dev/v1/me",
    headers={"Authorization": "Bearer <your-api-key>"},
)
print(response.json())

const response = await fetch("http://localhost:3000/api/dev/v1/me", {
  headers: { "Authorization": "Bearer <your-api-key>" },
});
const data = await response.json();const response = await fetch("http://localhost:3000/api/dev/v1/me", {
  headers: { "Authorization": "Bearer <your-api-key>" },
});
const data = await response.json();

A successful response returns your workspace and API key details:

{
  "workspace": {
    "id": "01JMXYZ...",
    "name": "My Workspace"
  },
  "api_key": {
    "key": "sk-...",
    "created_at": "2026-01-15T10:00:00Z"
  }
}{
  "workspace": {
    "id": "01JMXYZ...",
    "name": "My Workspace"
  },
  "api_key": {
    "key": "sk-...",
    "created_at": "2026-01-15T10:00:00Z"
  }
}

Base URL

All API requests use this base URL:

http://localhost:3000/api/dev/v1http://localhost:3000/api/dev/v1

Request Format

• Content-Type: application/json for all requests with a body
• Accept: application/json
• All timestamps are ISO 8601 UTC strings

Response Format

Successful responses return JSON with the resource data. Paginated list endpoints return:

{
  "items": [...],
  "next_cursor": "opaque-string-or-null",
  "total": 42
}{
  "items": [...],
  "next_cursor": "opaque-string-or-null",
  "total": 42
}

Use cursor in subsequent requests to page through results.

Error Responses

Error bodies include a detail field describing the problem:

{
  "detail": "Chatbot with this name already exists in workspace."
}{
  "detail": "Chatbot with this name already exists in workspace."
}

Rate Limits

The API applies rate limits per workspace. If you exceed the limit you receive 429 Too Many Requests. Wait before retrying - the Retry-After header indicates how many seconds to wait.