Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
AI API
A focused set of LLM-backed primitives that the Orbit platform uses internally — message analysis, reply suggestion, intent classification, summarization, content generation, and a small knowledge-base utility. The provider is abstracted: requests run through Orbit’s LLM gateway and you don’t manage OpenAI / Anthropic keys directly.
Base path: /v1/ai
Authentication: API key (X-API-Key) or session JWT. Service-to-service callers (with X-Internal-Token) get the developer role to cap blast radius.
Analysis & insight
| Method | Path | Purpose |
|---|
POST | /v1/ai/analyze | General message / content analysis |
POST | /v1/ai/analyze-message/{id} | Analyze a specific message by ID |
POST | /v1/ai/classify-intent | Classify a message’s intent |
POST | /v1/ai/summarize-conversation | Summarize a long conversation |
POST | /v1/ai/dashboard-insights | Generate dashboard insight prose |
Generation & rewriting
| Method | Path | Purpose |
|---|
POST | /v1/ai/suggest-reply | Draft a reply to an inbound message |
POST | /v1/ai/generate-content | Generate marketing content from a brief |
POST | /v1/ai/improve-text | Rewrite for tone / clarity / length |
POST | /v1/ai/translate | Translate to a target language |
POST | /v1/ai/compose-campaign | Compose a multi-step campaign from a goal |
POST | /v1/ai/optimize-channel | Recommend best channel/time for a contact |
Knowledge base
Small embedded KB sufficient for single-document reasoning. For multi-document, multi-tenant retrieval-augmented generation, use the Knowledge Bases API instead.
| Method | Path | Purpose |
|---|
GET | /v1/ai/kb/documents | List embedded KB documents |
POST | /v1/ai/kb/documents | Upload a document (multipart) |
GET | /v1/ai/kb/documents/{id} | Get a document |
DELETE | /v1/ai/kb/documents/{id} | Delete |
POST | /v1/ai/kb/documents/{id}/reindex | Force reindex |
POST | /v1/ai/kb/search | Semantic search across documents |
Example — suggest a reply
curl -X POST https://orbit-api.devotel.io/api/v1/ai/suggest-reply \
-H "X-API-Key: dv_live_sk_your_key_here" \
-H "Content-Type: application/json" \
-d '{
"conversation_id": "conv_abc",
"tone": "friendly",
"max_length": 240
}'
See also
