Axial settings API
This article and the rest of the API documentation in this section are written for a technical audience — integrators and developers connecting external systems to Tickiti. Familiarity with HTTP, REST, JSON and bearer-token authentication is assumed.
These endpoints read and change how Axial, Tickiti’s AI assistant, runs: the settings on the Axial menu’s pages (General, replies, inbound, dictation, models and limits), where its skills are kept (the skill store) and what it does with attachments. Two read-only endpoints give Axial usage and Axial reports. Working with Axial on tickets is in the Axial API.
Every save goes through the pages’ own code, so what can be set, and how it is checked, is exactly what the pages allow. Each change is logged with who made it and through which token. All endpoints are POST, take and return JSON, and use the response envelope described in the API overview. They need a plan that includes Axial.
Abilities and roles
- The settings, skill store and attachment-rule endpoints are in the administration family and need a token owned by an administrator (a system administrator, on a self-hosted installation), as the pages do:
administration:readreads,administration:writechanges. Write implies read. A token an Axial agent task works with never holdsadministration:write, so Axial cannot change how it runs itself. On a site hosted by Tickiti, Tickiti runs the skill store and the model and limit settings, and an administrator’s token cannot change them. axial/usageneedsreports:readand a superuser’s token, as Axial → Usage does.axial/reportsneedsreports:readand an administrator with Manage access to Axial, as Axial → Reports does.
Two settings are not changed here. The AI connection — Turn on AI and the API key on Axial → General — asks for the operator’s password, and is changed with administration/ai-assistant/update (see the Administration API). Who is shown Axial is set on Axial → General in the web app. axial/settings reports both.
Endpoints
| Method & path | Ability | Purpose |
|---|---|---|
| POST /api/v1/axial/settings | administration:read | Every Axial setting |
| POST /api/v1/axial/settings/update | administration:write | Change settings |
| POST /api/v1/axial/skill-store | administration:read | Where the skills are kept |
| POST /api/v1/axial/skill-store/update | administration:write | Keep skills in the database or a git repository |
| POST /api/v1/axial/skill-store/sync | administration:write | Catch up with the repository now |
| POST /api/v1/axial/attachment-rules | administration:read | What Axial does with each attachment type |
| POST /api/v1/axial/attachment-rules/save | administration:write | Create or change a rule |
| POST /api/v1/axial/attachment-rules/delete | administration:write | Delete a rule |
| POST /api/v1/axial/usage | reports:read | Tokens and estimated cost |
| POST /api/v1/axial/reports | reports:read | Staff ratings of Axial’s content |
Axial’s skills themselves are edited with the axial/skills endpoints (list, show, options, create, update, delete, and each skill’s actions and questions), which need an administrator’s token (a system administrator’s, on a self-hosted installation) with skills:read or skills:write. The MCP server’s Axial tools cover them.
Settings
axial/settings returns:
axial_enabledandaxial_ready— whether Axial is switched on, and whether it can run;connection— the AI connection’s state, never the key;settings— every setting on the pages, in the pages’ order: reply language, auto-send and its threshold, finishing, running on inbound mail and the queues it skips, whether actions need confirmation by default, the dictation glossary, and the models and limits;open_tools— the tools open to every skill;reply_style—ai_persona,ai_business_contextandai_signature;defaults— what a blank setting falls back to;models— what a model setting may be set to; andbrowser_only— the settings this API does not change.
axial/settings/update takes any of those settings, axial_open_tools (a list), axial_enabled and the three reply-style fields. Settings not sent stay as they are. The update is all or nothing: a value the page would refuse leaves every setting as it was, and the reply names it.
curl -X POST https://support.sole-provider.example/api/v1/axial/settings/update \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{
"axial_reply_language": "customer",
"ai_signature": "The Sole Provider support team"
}' Skill store
axial/skill-store reports where the skills are kept and, for a repository, its address, branch and last sync — never its password. skill-store/update takes store (database or git) and, for git, repo_url, branch, username and secret; a blank secret keeps the one saved. As on the page, turning git on checks the repository first and then syncs, and a repository that holds skills replaces the skills in Tickiti. skill-store/sync catches up with the repository now.
Attachment rules
axial/attachment-rules lists the rules by extension, with the modes a rule can take: auto, preprocess or ignore (see Axial attachment rules). attachment-rules/save takes extension, mode and optional max_bytes, note and enabled; without an id it creates a rule, with one it changes that rule. There is one rule per extension. attachment-rules/delete takes id.
These rules decide what Axial reads. Whether an attachment is accepted at all is set by the mail attachment rules in the Mail API.
Usage and reports
axial/usage returns the tokens Axial has used and their estimated cost, this month and in all.
axial/reports returns staff ratings of Axial’s content, with who gave them. It takes the page’s filters, all optional: from and to (YYYY-MM-DD), period, tz, choice, user and skill.