Propose a decision

POST/api/companies/{companyId}/decisions
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Propose a decision.

Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.

Authorization

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. How keys work.

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

titlestringRequired1–500 characters
bodystringRequiredat most 100000 characters
ruleKeystring | nullOptionalat most 240 characters
optionsarray<object>Required
options[].idstringRequired1–120 characters
options[].labelstringRequired1–240 characters
options[].descriptionstring | nullOptionalat most 2000 characters
options[].stylestringOptionalone of: "default", "primary", "destructive"
options[].effectsarray<object>Required
inputsarray<object> | nullOptional
inputs[].idstringRequired1–120 characters
inputs[].labelstringRequired1–240 characters
inputs[].placeholderstring | nullOptionalat most 500 characters
inputs[].requiredbooleanOptional
inputs[].maxLengthintegerOptional> 0≤ 20000
expiresAtstring (date-time)Optional
idempotencyKeystring | nullOptional1–500 characters
continuationPolicystringOptionalone of: "none", "wake_origin_agent"
metadataobjectOptional

Responses

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).

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Decisions