Skip to main content
The IllumiChat API lets you manage assistants, conversations, contacts, tickets, and more. All endpoints follow REST conventions and return JSON responses.

​
Base URL

https://beta.illumichat.com/api

​
Request Format

  • Use Content-Type: application/json for request bodies
  • Include authentication credentials with every request (see Authentication)
  • URL path parameters are denoted with {paramName} in the endpoint documentation

​
Example Request

curl -X GET https://beta.illumichat.com/api/assistants \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json"

​
Response Format

All successful responses return JSON. The structure depends on the endpoint: 
// Single resource
{
  "id": "abc123",
  "name": "My Assistant",
  "createdAt": "2025-01-15T10:30:00Z"
}

// Collection
[
  { "id": "abc123", "name": "Assistant A" },
  { "id": "def456", "name": "Assistant B" }
]
Error responses use a consistent format described in Errors & Status Codes.

​
Authentication Methods

MethodUse CaseDetails
Session cookieBrowser-based appsSet automatically after Auth0 login
Bearer tokenServer-to-serverPass in Authorization header
Public (no auth)Widget & SMS webhooksRate-limited by IP or assistant
See Authentication for full details.

​
API Sections

Authentication

Session cookies, API keys, and public endpoints.

Errors & Status Codes

Error format, HTTP codes, and handling patterns.

Rate Limiting

Request limits, widget quotas, and backoff strategies.

Endpoint Reference

Browse individual endpoint documentation generated from the OpenAPI spec.

​
Key Endpoint Groups

GroupBase PathDescription
Assistants/api/assistantsCreate, update, and manage AI assistants
Chat/api/chatSend messages and stream responses
Projects/api/projectsManage projects and documents for RAG
Contacts/api/contactsCreate and manage contacts
Tickets/api/ticketsSupport ticket lifecycle
Widget/api/widget/{assistantId}Public widget endpoints
SMS/api/smsTwilio webhook endpoints
Webhooks/api/webhooksManage webhook subscriptions
The full OpenAPI specification is available and powers the auto-generated endpoint pages in this documentation. You can also download it for use with tools like Postman or code generators.