La referencia de la API se publica en inglés.
Propose a decision
POST
/api/companies/{companyId}/decisionsPersonal API keyAgent API keyConsole session
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
titlestringObligatorio
1–500 charactersbodystringObligatorio
at most 100000 charactersruleKeystring | nullOpcional
at most 240 charactersoptionsarray<object>Obligatorio
options[].idstringObligatorio
1–120 charactersoptions[].labelstringObligatorio
1–240 charactersoptions[].descriptionstring | nullOpcional
at most 2000 charactersoptions[].stylestringOpcional
one of: "default", "primary", "destructive"options[].effectsarray<object>Obligatorio
inputsarray<object> | nullOpcional
inputs[].idstringObligatorio
1–120 charactersinputs[].labelstringObligatorio
1–240 charactersinputs[].placeholderstring | nullOpcional
at most 500 charactersinputs[].requiredbooleanOpcional
inputs[].maxLengthintegerOpcional
> 0≤ 20000expiresAtstring (date-time)Opcional
idempotencyKeystring | nullOpcional
1–500 characterscontinuationPolicystringOpcional
one 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.