API referansı İngilizce yayımlanır.
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.
Yetkilendirme
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. Anahtarlar nasıl çalışır.
Yol parametreleri
companyIdstringZorunluThe organization's id.
İstek gövdesi
application/json · zorunlu
titlestringZorunlu
1–500 charactersbodystringZorunlu
at most 100000 charactersruleKeystring | nullİsteğe bağlı
at most 240 charactersoptionsarray<object>Zorunlu
options[].idstringZorunlu
1–120 charactersoptions[].labelstringZorunlu
1–240 charactersoptions[].descriptionstring | nullİsteğe bağlı
at most 2000 charactersoptions[].stylestringİsteğe bağlı
one of: "default", "primary", "destructive"options[].effectsarray<object>Zorunlu
inputsarray<object> | nullİsteğe bağlı
inputs[].idstringZorunlu
1–120 charactersinputs[].labelstringZorunlu
1–240 charactersinputs[].placeholderstring | nullİsteğe bağlı
at most 500 charactersinputs[].requiredbooleanİsteğe bağlı
inputs[].maxLengthintegerİsteğe bağlı
> 0≤ 20000expiresAtstring (date-time)İsteğe bağlı
idempotencyKeystring | nullİsteğe bağlı
1–500 characterscontinuationPolicystringİsteğe bağlı
one of: "none", "wake_origin_agent"metadataobjectİsteğe bağlı
Yanıtlar
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).
Hatalar {"error": "..."} döndürür, çoğu zaman bir code ve details ile birlikte. Ayrıntılar için: hatalar ve limitler.