Справочник API публикуется на английском языке.
Propose a decision bundle
POST
/api/companies/{companyId}/decision-bundlesPersonal API keyAgent API keyConsole session
Propose a decision bundle.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Параметры пути
companyIdstringОбязательныйThe organization's id.
Тело запроса
application/json · обязательно
titlestringОбязательный
1–500 characterssummarystringОбязательный
at most 100000 charactersdecisionsarray<object>Обязательный
decisions[].titlestringОбязательный
1–500 charactersdecisions[].bodystringОбязательный
at most 100000 charactersdecisions[].ruleKeystring | nullНеобязательный
at most 240 charactersdecisions[].optionsarray<object>Обязательный
decisions[].options[].idstringОбязательный
1–120 charactersdecisions[].options[].labelstringОбязательный
1–240 charactersdecisions[].options[].descriptionstring | nullНеобязательный
at most 2000 charactersdecisions[].options[].stylestringНеобязательный
one of: "default", "primary", "destructive"decisions[].options[].effectsarray<object>Обязательный
decisions[].inputsarray<object> | nullНеобязательный
decisions[].inputs[].idstringОбязательный
1–120 charactersdecisions[].inputs[].labelstringОбязательный
1–240 charactersdecisions[].inputs[].placeholderstring | nullНеобязательный
at most 500 charactersdecisions[].inputs[].requiredbooleanНеобязательный
decisions[].inputs[].maxLengthintegerНеобязательный
> 0≤ 20000decisions[].expiresAtstring (date-time)Необязательный
decisions[].idempotencyKeystring | nullНеобязательный
1–500 charactersdecisions[].continuationPolicystringНеобязательный
one of: "none", "wake_origin_agent"decisions[].metadataobjectНеобязательный
Ответы
201SuccessCreated; the body holds the new resource.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
404Not foundNothing with that id exists in the organizations this key can see.
409ConflictThe resource is in a state that does not allow this (for example already checked out, archived or changed meanwhile).
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.