API/API (Swagger)
API (Swagger)
v1.0.x · навсозӣ шуд 2026-06-27
Кашшофи интерактивии Swagger UI барои тамоми API-и HTTP-и AiHummer. Ҳар як
нуқтаи ниҳоии нусхаи шумо дар ин ҷост: сатҳи чати OpenAI-мутобиқ
(POST /v1/chat/completions), паёмҳо ва триггерҳои воридшаванда, ҷуфтсозии дастгоҳ,
таъминоти SSO/SCIM, ва API-и пурраи админ — идоракунии агентҳо, дониш,
аналитика, модулҳо ва амният.
Open Swagger UI →
Аутентификатсия
Дархостҳо бо як калиди API-и AiHummer (бо ah- пешванд карда мешуда), ки ҳамчун
токени Bearer ирсол мешавад, аутентификатсия мешаванд:
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Калидҳо аз UI-и админи веб дода мешаванд. Дар Swagger UI, Authorize-ро пахш кунед ва
калидро часпонед, то дархостҳои зиндаи “Try it out”-ро аз браузери худ иҷро кунед.
Сервер
Мушаххасот бо як ҷойнигаҳдори https://your-instance.example.com интиқол меёбад — суроғаи
нусхаи худро аз рӯйхати поёнравандаи серверҳо интихоб кунед ё онро бо суроғаи худ иваз кунед (дар
истеҳсолот TLS дар як reverse proxy-и пеши шлюз қатъ карда мешавад).
[!TIP]
Мушаххасоти мошинхонӣ дар /openapi.json дастрас аст ва
ба Postman, Insomnia ё editor.swagger.io ба таври тоза ворид мешавад.
Минбаъд ба куҷо
Кашшофи интерактивии **Swagger UI** барои тамоми API-и HTTP-и AiHummer. Ҳар як
нуқтаи ниҳоии нусхаи шумо дар ин ҷост: сатҳи чати OpenAI-мутобиқ
(`POST /v1/chat/completions`), паёмҳо ва триггерҳои воридшаванда, ҷуфтсозии дастгоҳ,
таъминоти SSO/SCIM, ва API-и пурраи админ — идоракунии агентҳо, дониш,
аналитика, модулҳо ва амният.
<p style="margin:1.5rem 0;">
<a href="/api/" style="display:inline-block;padding:0.85rem 1.5rem;border-radius:10px;background:#F0632E;color:#1a0d08;font-weight:600;text-decoration:none;">
Open Swagger UI →
</a>
</p>
## Аутентификатсия
Дархостҳо бо як калиди API-и AiHummer (бо `ah-` пешванд карда мешуда), ки ҳамчун
токени Bearer ирсол мешавад, аутентификатсия мешаванд:
```http
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```
Калидҳо аз UI-и админи веб дода мешаванд. Дар Swagger UI, **Authorize**-ро пахш кунед ва
калидро часпонед, то дархостҳои зиндаи "Try it out"-ро аз браузери худ иҷро кунед.
## Сервер
Мушаххасот бо як ҷойнигаҳдори `https://your-instance.example.com` интиқол меёбад — суроғаи
нусхаи худро аз рӯйхати поёнравандаи серверҳо интихоб кунед ё онро бо суроғаи худ иваз кунед (дар
истеҳсолот TLS дар як reverse proxy-и пеши шлюз қатъ карда мешавад).
> [!TIP]
> Мушаххасоти мошинхонӣ дар [`/openapi.json`](/openapi.json) дастрас аст ва
> ба Postman, Insomnia ё editor.swagger.io ба таври тоза ворид мешавад.
## Минбаъд ба куҷо
- Нуқтаи ниҳоии чат ба тафсил: [API-и Chat Completions](/en/v1.0/api/chat-completions).
- Паёмҳо ва триггерҳои воридшаванда: [Воридшаванда ва триггерҳо](/en/v1.0/api/inbound-triggers).
- Ҷуфтсозӣ, SSO ва протоколҳо: [Webhook-ҳо, SCIM ва ҷуфтсозӣ](/en/v1.0/api/webhooks-scim-pairing).