API Reference
API Reference
REST APIs for ingesting content and serving published articles.
The Reaktly REST API speaks JSON over HTTPS and authenticates with API keys in the x-api-key header.
Base URL
https://api.reaktly.comPublic APIs
Authentication
API keys, scopes, rotation, and security
Ingestion API
Push content into a knowledge base
Articles API
Serve published articles and questions
| API | Scope | What it is for |
|---|---|---|
| Ingestion API | iq:import | Send content from your CMS, shop, or database into a knowledge base |
| Articles API | articles:read | Read published articles, categories, and entry-point questions for your own help centre |
| Authentication | — | Creating keys, scopes, and error codes |
Conventions
- Authentication — every request carries
x-api-key. The tenant is derived from the key, not from the request body. - Ingestion is asynchronous — an accepted item is queued for processing;
jobIds let you correlate a submission with your own records. - Backoff on
429— see Error handling. - Errors are standard HTTP status codes with a JSON body describing the problem (
400invalid payload,401missing key,403missing scope,404unknown resource).
Not in the public API
Dashboard features — conversations, analytics, widget configuration, team management — are served by private session-authenticated endpoints. They are not documented here and are not covered by API keys.
The API-key scope model already names reserved scopes for future public surface (iq:read, iq:embed, iq:enrich, iq:diagnostics). They stay inert until the corresponding endpoints ship.