API referansı İngilizce yayımlanır.
Propose a decision bundle
POST
/api/companies/{companyId}/decision-bundlesPersonal API keyAgent API keyConsole session
Propose a decision bundle.
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 characterssummarystringZorunlu
at most 100000 charactersdecisionsarray<object>Zorunlu
decisions[].titlestringZorunlu
1–500 charactersdecisions[].bodystringZorunlu
at most 100000 charactersdecisions[].ruleKeystring | nullİsteğe bağlı
at most 240 charactersdecisions[].optionsarray<object>Zorunlu
decisions[].options[].idstringZorunlu
1–120 charactersdecisions[].options[].labelstringZorunlu
1–240 charactersdecisions[].options[].descriptionstring | nullİsteğe bağlı
at most 2000 charactersdecisions[].options[].stylestringİsteğe bağlı
one of: "default", "primary", "destructive"decisions[].options[].effectsarray<object>Zorunlu
decisions[].inputsarray<object> | nullİsteğe bağlı
decisions[].inputs[].idstringZorunlu
1–120 charactersdecisions[].inputs[].labelstringZorunlu
1–240 charactersdecisions[].inputs[].placeholderstring | nullİsteğe bağlı
at most 500 charactersdecisions[].inputs[].requiredbooleanİsteğe bağlı
decisions[].inputs[].maxLengthintegerİsteğe bağlı
> 0≤ 20000decisions[].expiresAtstring (date-time)İsteğe bağlı
decisions[].idempotencyKeystring | nullİsteğe bağlı
1–500 charactersdecisions[].continuationPolicystringİsteğe bağlı
one of: "none", "wake_origin_agent"decisions[].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.