agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
احراز هویت
یک کلید API را به عنوان یک توکن برbearer ارسال کنید. این نقطه پایانی مجوز خاصی را در مشخصات خود ذکر نمیکند، بنابراین به جای فرض کردن، حداقل نیازهای کلید خود را بدهید و پاسخ را بررسی کنید.
این نقطه پایانی هیچ شناسه سازمانی را دریافت نمیکند. کلید شما در حال حاضر سازمان مربوطه را مشخص میکند و پاسخ در همان محدوده ارائه میشود.
امتحان کنید
هر چیزی را که داخل براکتهای زاویهدار قرار دارد با مقادیر خودتان جایگزین کنید، و نگهدارنده کلید را با کلیدی از داشبورد خود جایگزین نمایید.
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 در داشبورد شما شناسه سازمان واقعی و کلید خودتان را پر میکند و درخواست را روی 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; `forc… |
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 Englis… |
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