La referencia de la API se publica en inglés.

Propose a decision

POST/api/companies/{companyId}/decisions
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

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.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

titlestringObligatorio1–500 characters
bodystringObligatorioat most 100000 characters
ruleKeystring | nullOpcionalat most 240 characters
optionsarray<object>Obligatorio
options[].idstringObligatorio1–120 characters
options[].labelstringObligatorio1–240 characters
options[].descriptionstring | nullOpcionalat most 2000 characters
options[].stylestringOpcionalone of: "default", "primary", "destructive"
options[].effectsarray<object>Obligatorio
inputsarray<object> | nullOpcional
inputs[].idstringObligatorio1–120 characters
inputs[].labelstringObligatorio1–240 characters
inputs[].placeholderstring | nullOpcionalat most 500 characters
inputs[].requiredbooleanOpcional
inputs[].maxLengthintegerOpcional> 0≤ 20000
expiresAtstring (date-time)Opcional
idempotencyKeystring | nullOpcional1–500 characters
continuationPolicystringOpcionalone of: "none", "wake_origin_agent"
metadataobjectOpcional

Respuestas

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

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Decisions