API referansı İngilizce yayımlanır.

Propose a decision

POST/api/companies/{companyId}/decisions
Personal API keyAgent API keyConsole session
Veyra Docs TeamGüncellendi Sürüm 3 · Geçmiş

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

titlestringZorunlu1–500 characters
bodystringZorunluat most 100000 characters
ruleKeystring | nullİsteğe bağlıat most 240 characters
optionsarray<object>Zorunlu
options[].idstringZorunlu1–120 characters
options[].labelstringZorunlu1–240 characters
options[].descriptionstring | nullİsteğe bağlıat most 2000 characters
options[].stylestringİsteğe bağlıone of: "default", "primary", "destructive"
options[].effectsarray<object>Zorunlu
inputsarray<object> | nullİsteğe bağlı
inputs[].idstringZorunlu1–120 characters
inputs[].labelstringZorunlu1–240 characters
inputs[].placeholderstring | nullİsteğe bağlıat most 500 characters
inputs[].requiredbooleanİsteğe bağlı
inputs[].maxLengthintegerİsteğe bağlı> 0≤ 20000
expiresAtstring (date-time)İsteğe bağlı
idempotencyKeystring | nullİsteğe bağlı1–500 characters
continuationPolicystringİ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.

Decisions