agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
Баталгаажуулалт
API түлхүүрийг bearer token хэлбэрээр илгөэнэ үү. Энэхүү төгсгөлийн цэг нь тодорхойлолтдоо тодорхой зөвшөөрлийг заагаагүй тул түлхүүрээрээ шаардагдах хамгийн бага эрхийг өгч, таамаглахаас илүүтэйгээр хариуг шалгана уу.
Энэ төгсгөл цэг нь ямар ч байгууллагын ID шаардахгүй. Таны түлхүүр аль хэдийн харьяалагдах байгууллагыг тодорхойлж байгаа бөгөөд хариу нь тухайн байгууллагын хүрээнд хязгаарлагдана.
Туршиж үзэх
Өнцөг хаалтанд байгаа бүх зүйлийг өөрийн утгаар солиж, түлхүүр санамж байрлуулагчийг хяналтын самбарынхаа түлхүүрээр сольж оруулна уу.
curl -X POST https://api.zinndigital.com/v1/agency/boards/{boardId}/ai/run \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "function": <string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked>> }'Та нэвтэрсэн байна уу? Таны хяналтын самбар дахь API консол нь таны бодит байгууллагын ID болон өөрийн түлхүүрийг автоматаар бөглөж, шууд ажиллаж буй API рүү хүсэлт илгээх тул та бодит хариуг харах боломжтой болно. Энэ төгсгөлийн цэгийг API консол дээр нээх
Дэлгэрэнгүй
Runs a board AI function and returns its output. A refusal to spend is a 200, not a 4xx. When the org has no AI credit, no provider key, or is not in good standing, the response carries skipped: true with a skipReason and a customer-readable text — because the customer asked and we told them why not, which is a complete answer rather than a fault in their request. ⛔ A client reading 200 as "it ran" will record a success for a call that did nothing. Read skipped. apply defaults to false: AI on a board proposes and a person commits.
Параметрүүд
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
boardId (path) | Uuid | Тийм | Project board ID (UUIDv7). |
Хүсэлтийн бие
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
function | string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked> | Тийм | Which AI function to run. |
card_id | Uuid | Үгүй | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
apply | boolean | Үгүй | Write the result to the board. Defaults to false: AI on a board proposes and a person commits, so the irreversible half must be asked for explicitly. |
force | boolean | Үгүй | Re-run rather than replay. An identical call within 15 minutes is served from the previous run with no model call and no charge, so a retried automation cannot bill twice; force… |
options | object | Үгүй | Per-function input. draft_card takes brief and optionally source; release_notes takes column_id. |
Хариу үйлдэл
| Нэр | Төрөл | Заавал шаардлагатай | Энэ юу вэ |
|---|---|---|---|
function | string | Тийм | — |
text | string | Тийм | The output, or the reason it was skipped. |
payload | object | Үгүй | Structured result — labels, sub-tasks, candidate duplicates. |
model | string | Үгүй | The model that served it. Null on a skip, because none was chosen. |
provider | string | Үгүй | — |
funding | string<byo, credits, included> | Үгүй | Who paid. byo is the customer's own provider key; credits and included are Zinn®'s. All three are recorded on the same meter. |
usage_id | Uuid | Үгүй | The meter row, so board history and AI spend join up. Null on a skip. |
skipped | boolean | Тийм | Read this. True means nothing ran and nothing was charged. A caller that treats 200 as "it worked" records a success for a call that did nothing. |
skip_reason | string | Үгүй | Machine-readable cause, e.g. AI_BUDGET_EXHAUSTED, AI_NOT_IN_GOOD_STANDING, not_enough_discussion, nothing_blocked. |
skip_kind | string<nothing_to_do, not_in_good_standing, not_entitled, unavailable> | Үгүй | The CLASS of the skip, beside its code. nothing_to_do is the product working (a healthy board has nothing blocked; a thread is too short to summarise) and is good news, not a… |
skip_params | object | Үгүй | The values the refusal sentence quotes (count, column), sent structurally so a client can render that sentence in the customer's own language rather than the engine's English.… |
failure | VendorFailure | Үгүй | CLAUDE.md §57 — what to tell the customer about a refusal, as a stable message key plus a tone, so the dashboard renders the sentence in their own language. Present only on a… |
cached | boolean | Үгүй | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | Үгүй | — |
run_id | Uuid | Үгүй | — |
Энэ төгсгөл цэгээс буцааж болох алдаанууд
401 · 403 · 404 · 422