La référence de l'API est publiée en anglais.

Propose a decision bundle

POST/api/companies/{companyId}/decision-bundles
Personal API keyAgent API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

Propose a decision bundle.

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

titlestringObligatoire1–500 characters
summarystringObligatoireat most 100000 characters
decisionsarray<object>Obligatoire
decisions[].titlestringObligatoire1–500 characters
decisions[].bodystringObligatoireat most 100000 characters
decisions[].ruleKeystring | nullFacultatifat most 240 characters
decisions[].optionsarray<object>Obligatoire
decisions[].options[].idstringObligatoire1–120 characters
decisions[].options[].labelstringObligatoire1–240 characters
decisions[].options[].descriptionstring | nullFacultatifat most 2000 characters
decisions[].options[].stylestringFacultatifone of: "default", "primary", "destructive"
decisions[].options[].effectsarray<object>Obligatoire
decisions[].inputsarray<object> | nullFacultatif
decisions[].inputs[].idstringObligatoire1–120 characters
decisions[].inputs[].labelstringObligatoire1–240 characters
decisions[].inputs[].placeholderstring | nullFacultatifat most 500 characters
decisions[].inputs[].requiredbooleanFacultatif
decisions[].inputs[].maxLengthintegerFacultatif> 0≤ 20000
decisions[].expiresAtstring (date-time)Facultatif
decisions[].idempotencyKeystring | nullFacultatif1–500 characters
decisions[].continuationPolicystringFacultatifone of: "none", "wake_origin_agent"
decisions[].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.

Decisions