API Reference

Overview

The REST API provides full programmatic access to your AI agent. Use it to build custom chat interfaces, automate workflows, or integrate with your existing tools.

Base URL

https://api.your-domain.com/v1

Quick Links

• Authentication — API keys and auth methods
• Streaming — Real-time streaming responses
• Error Handling — Error codes and troubleshooting
• Pagination — Navigate large result sets

Endpoints

• Chat — Send messages and receive responses
• Conversations — Manage conversation threads
• Messages — Access individual messages

Response Format

All responses use JSON with a consistent envelope:

{
  "data": { ... },
  "meta": {
    "request_id": "req_abc123"
  }
}

Error responses follow the same pattern:

{
  "error": {
    "code": "invalid_request",
    "message": "The 'message' field is required."
  },
  "meta": {
    "request_id": "req_abc123"
  }
}