Справочник API публикуется на английском языке.

Propose a decision bundle

POST/api/companies/{companyId}/decision-bundles
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

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 characters
summarystringОбязательныйat most 100000 characters
decisionsarray<object>Обязательный
decisions[].titlestringОбязательный1–500 characters
decisions[].bodystringОбязательныйat most 100000 characters
decisions[].ruleKeystring | nullНеобязательныйat most 240 characters
decisions[].optionsarray<object>Обязательный
decisions[].options[].idstringОбязательный1–120 characters
decisions[].options[].labelstringОбязательный1–240 characters
decisions[].options[].descriptionstring | nullНеобязательныйat most 2000 characters
decisions[].options[].stylestringНеобязательныйone of: "default", "primary", "destructive"
decisions[].options[].effectsarray<object>Обязательный
decisions[].inputsarray<object> | nullНеобязательный
decisions[].inputs[].idstringОбязательный1–120 characters
decisions[].inputs[].labelstringОбязательный1–240 characters
decisions[].inputs[].placeholderstring | nullНеобязательныйat most 500 characters
decisions[].inputs[].requiredbooleanНеобязательный
decisions[].inputs[].maxLengthintegerНеобязательный> 0≤ 20000
decisions[].expiresAtstring (date-time)Необязательный
decisions[].idempotencyKeystring | nullНеобязательный1–500 characters
decisions[].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. Подробнее: ошибки и ограничения.

Decisions