Welcome
Aurion AI developer documentation — guides, API reference, and integration resources.
Aurion Developer Docs
Welcome to the Aurion AI developer portal. Everything you need to integrate with the Aurion platform — from creating tickets and managing conversations to embedding voice AI and building automations.
Quick Links
- Getting Started — Create an API key and make your first request
- Authentication — API key scopes, enforcement, and error handling
- API Reference — Full endpoint reference with interactive playground
- Webhooks — Real-time event notifications with HMAC verification
Explore by Feature
The public, API-key-authenticated surface is v1-only. The guides below are grouped by how they are accessed — see The public API key is v1-only below.
Public API (authenticate with an X-API-Key key)
| Area | Guide | Description |
|---|---|---|
| Ticketing | Tickets | Ticket CRUD on tickets stored in Aurion |
| Voice | Calls & Recordings | Voice call data, transcripts, and recordings |
| Voice | Voice Widget | Embed AI voice support on your website (config scope) |
| Analytics | Usage & Billing | Usage tracking and plan limits |
Other auth models
| Area | Guide | Access |
|---|---|---|
| Knowledge | Help Center | Public self-service portal — read endpoints need no authentication |
| End-User | End-User API | Mobile app and widget — separate end-user JWT Bearer token, not an API key |
CS helpdesk (dashboard session only — not yet in the public API)
These guides document the Aurion CS helpdesk surface. The endpoints are part of the /api/v2/*
(and a few non-allowlisted /api/v1/* and /api/kb) routers and are currently reachable only through an
authenticated dashboard session — a request authenticated with X-API-Key returns 403.
| Area | Guide | Description |
|---|---|---|
| Ticketing | Conversations | Omnichannel conversations (email, chat, WhatsApp, voice) |
| Channels | Channels | Email, WhatsApp, and saved reply configuration |
| Automation | Automation & Workflows | Rules, visual workflows, and webhook triggers |
| Automation | SLA Management | SLA policies, targets, and compliance |
| Teams | Teams & Routing | Team management, routing, and business hours |
| Teams | On-Call Scheduling | On-call rotations and shift management |
| Teams | Notifications | Notification preferences, quiet hours, delivery |
| Contacts | Contacts & Companies | Contact and company management |
| Satisfaction | CSAT Surveys | Customer satisfaction surveys and analytics |
| Analytics | Analytics | Conversation analytics, SLA compliance, AI insights |
| Knowledge | Knowledge Base | KB article management with LLM processing |
Base URLs
| Environment | URL |
|---|---|
| Production | https://apps.aurionai.net/api/v1 |
| Staging | https://apps-staging.aurionai.net/api/v1 |
Staging is a shared stack, not a separately isolated data sandbox.
Authentication
All public API requests require an X-API-Key header. Keys are minted in the format
itsm_sk_{env}_{random} — itsm_sk_test_… for a sandbox tenant, itsm_sk_live_… for every other tenant (staging included):
curl -H "X-API-Key: itsm_sk_live_xxxx" \
https://apps.aurionai.net/api/v1/ticketsEnd-user endpoints (mobile app, widget) use a separate end-user JWT Bearer token instead — never
an X-API-Key. See End-User API for details. Help Center
read endpoints are public and need no authentication at all.
Rate limits depend on your tenant's plan and include a 10-second burst limit. See
Error Handling → Rate Limiting for the limits per plan, the headers and the 429 bodies.
The public API key is v1-only
ℹ️ Public API keys reach v1 endpoints only
The public, key-authenticated API is v1-only. An
X-API-Keyrequest to any/api/v2/*path returns403. The/api/v2surface backs the Aurion CS helpdesk and is reachable only through an authenticated dashboard session. The CS feature guides listed above (Conversations, Channels, Automation, SLA, Teams, On-Call, Notifications, Contacts, CSAT, Analytics, and Knowledge Base) document that dashboard surface (Knowledge Base also uses/api/kb) — they are not part of the public API key contract.
| Version | Base Path | API-key reachable? | Use Case |
|---|---|---|---|
| v1 | /api/v1/ | Yes (allowlisted prefixes) | ITSM tickets, calls, usage, billing, webhooks, voice-widget config |
| v2 | /api/v2/ | No — 403 for API keys | Aurion CS helpdesk (dashboard session auth) |
v1 endpoints make up the public API: tickets (stored in Aurion, not sent to your ITSM tool), calls, usage, billing, and webhooks expose your account data. v2 endpoints power the Aurion CS helpdesk dashboard and are not exposed through public API keys.