Troupia API
Подключите любую систему к своим автоматизациям, запускам и разговорам, одним ключом.
Сначала: ключ API
Владелец или администратор создаёт его в Настройках → Ключи API и выбирает, что ему разрешено. Каждый запрос отправляет его так:
Authorization: Bearer trp_live_…
Автоматизации
/v1/automationsAll automations
Your workspace's automations, a page at a time.
automations:read/v1/automations/{automationId}One automation
Its steps, every way it starts and its version. Never a secret.
automations:readETag: "7.1a2b3c4d"
Сохраните ETag. Изменение отправляет его обратно.
/v1/automations/{automationId}Rename
automations:writeIf-Match: "7.1a2b3c4d"
Если кто-то изменил автоматизацию после вашего чтения: 412, и ничего не перезаписывается. Прочитайте снова и решите.
/v1/automations/{automationId}/enableTurn on
The plan's schedule floor applies, as in the app.
automations:writeIf-Match: "7.1a2b3c4d"
Запрос уже существующего состояния возвращает 200 и ничего не меняет. Запланированные запуски сохраняются.
/v1/automations/{automationId}/disableTurn off
automations:writeIf-Match: "7.1a2b3c4d"
Запрос уже существующего состояния возвращает 200 и ничего не меняет. Запланированные запуски сохраняются.
/v1/automations/resolve-linkFrom a link
A Troupia link → the automation or run it names.
automations:readЗапуски
/v1/automations/{automationId}/runsAn automation's runs
A page at a time.
runs:read/v1/automations/{automationId}/analysisRuns analysed
How many succeeded, how many failed and why, over a window.
runs:read/v1/automations/runs/{runId}One run
With what went in and out of each step.
runs:read_payloads/v1/runs/{runId}A chat run
data:readРазговоры
/v1/conversationsConversations
data:read/v1/conversationsStart a conversation
chat:write/v1/conversations/{conversationId}/messagesSend a message
chat:write/v1/conversations/{conversationId}/exportExport a conversation
data:readWebhooks
/v1/automations/{automationId}/webhookWebhook addresses and their secrets
webhooks:manageТолько ключ владельца или администратора: проверяется при каждом вызове, каждый вызов записывается.
/v1/webhook-endpoints/{endpointId}/deliveriesFailed deliveries
To one outgoing endpoint: newest first, a page at a time.
webhooks:manageПлагины
/v1/plugins/{slug}/openapi.jsonA plugin's API
Each plugin publishes its own OpenAPI document.
data:read/v1/plugins/{slug}/{entity}A plugin's records
data:read/v1/plugins/{slug}/{entity}Create a record
data:write/v1/plugins/{slug}/{entity}/{id}One record
data:read/v1/plugins/{slug}/{entity}/{id}Update a record
data:write/v1/plugins/crm/{path}Read from the CRM
crm:read/v1/plugins/crm/{path}Write to the CRM
crm:writeОб API
/v1/openapi.jsonThis document
As OpenAPI 3.1, no key needed.
Без ключаКогда что-то не проходит
| 401 | Нет ключа, или он недействителен. |
| 403 | У ключа нет этого разрешения. |
| 404 | Не найдено в этом рабочем пространстве. |
| 412 | Автоматизация изменилась после вашего чтения. |
| 428 | Не хватает If-Match. |
| 429 | Слишком много запросов. Подождите и повторите. |