La référence de l'API est publiée en anglais.
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.
Autorisation
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. Fonctionnement des clés.
Paramètres de chemin
companyIdstringObligatoireThe organization's id.
Corps de la requête
application/json · obligatoire
titlestringObligatoire
1–500 charactersbodystringObligatoire
at most 100000 charactersruleKeystring | nullFacultatif
at most 240 charactersoptionsarray<object>Obligatoire
options[].idstringObligatoire
1–120 charactersoptions[].labelstringObligatoire
1–240 charactersoptions[].descriptionstring | nullFacultatif
at most 2000 charactersoptions[].stylestringFacultatif
one of: "default", "primary", "destructive"options[].effectsarray<object>Obligatoire
inputsarray<object> | nullFacultatif
inputs[].idstringObligatoire
1–120 charactersinputs[].labelstringObligatoire
1–240 charactersinputs[].placeholderstring | nullFacultatif
at most 500 charactersinputs[].requiredbooleanFacultatif
inputs[].maxLengthintegerFacultatif
> 0≤ 20000expiresAtstring (date-time)Facultatif
idempotencyKeystring | nullFacultatif
1–500 characterscontinuationPolicystringFacultatif
one of: "none", "wake_origin_agent"metadataobjectFacultatif
Réponses
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).
Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.