Developers

Build custom integrations against the CrafterQ Public API. Use it to start and continue chat conversations, submit action forms, and retrieve agent chat configuration from your own applications.

Interactive API Reference

The full OpenAPI reference is generated from the public specification and rendered with Redoc. Open it for request/response schemas, parameters, and example payloads:

Open Public API Reference

Base URL

All Public API requests are made against:

https://api.crafterq.ai/v1

Authentication

Endpoints use one or both of the following schemes (see each operation in the API reference for details):

  • JWT bearer token (Authorization: Bearer <token>) — obtained from the agent chat_config endpoint; identifies and authorizes the chat user.

  • Chat user header (X-CrafterQ-Chat-User) — identifies the anonymous chat session.

Q Keys

Organization Owners and Admins create Q Keys in the Console for apps and integrations. The key is shown only once. See Q Keys.

The public chat API on this page does not use Q Keys. The Admin API accepts a Q Key as a bearer token. What the key can call is limited to the scope chosen when it was created.

What’s next

  • Explore operations by tag in the Public API Reference: Chats, Actions, and related service endpoints.

  • For embedding the chat widget on a website (no custom API client required), see AI Agents.

  • To create a key for an integration, see Q Keys.