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