agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
Doğrulama
API açarını bearer token kimi göndərin. Bu səhifə spresifikasiyada xüsusi icazə tələb etmir, buna görə də açarınıza ehtiyac duyduğu minimum səviyyədə icazə verin və güman etmək əvəzinə cavabı yoxlayın.
Bu endpoint heç bir təşkilat ID-si tələb etmir. Sizin açarınız artıq aid olduğu təşkilatı müəyyən edir və cavab həmin təşkilat üçün məhdudlaşdırılır.
Sınaqdan keçir
Bucaqlı mötərizələrdə olan hór şeyi öz qiymətlərinizlə, açar yertutucusunu isə idarə panelinizdən bir açarla əvəz edin.
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>> }'Sistemə daxil olmusunuz? İdarə panelinizdəki API konsolu real təşkilatınızın identifikatorunu və öz açarınızı avtomatik doldurur, sorğunu canlı API-yə qarşı icra edir ki, siz faktiki cavabı görə biləsiniz. Bu son nöqtəni API konsolunda açın
Təfərrüatlar
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.
Parametrlər
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
boardId (path) | Uuid | Bəli | Project board ID (UUIDv7). |
Sorğu gövdəsi
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
function | string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked> | Bəli | Which AI function to run. |
card_id | Uuid | Xeyr | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
apply | boolean | Xeyr | 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 | Xeyr | 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 | Xeyr | Per-function input. draft_card takes brief and optionally source; release_notes takes column_id. |
Cavab
| Ad | Tip | Tələb olunur | Nədir |
|---|---|---|---|
function | string | Bəli | — |
text | string | Bəli | The output, or the reason it was skipped. |
payload | object | Xeyr | Structured result — labels, sub-tasks, candidate duplicates. |
model | string | Xeyr | The model that served it. Null on a skip, because none was chosen. |
provider | string | Xeyr | — |
funding | string<byo, credits, included> | Xeyr | 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 | Xeyr | The meter row, so board history and AI spend join up. Null on a skip. |
skipped | boolean | Bəli | 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 | Xeyr | 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> | Xeyr | 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 | Xeyr | 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 | Xeyr | 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 | Xeyr | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | Xeyr | — |
run_id | Uuid | Xeyr | — |
Bu son nöqtənin qaytara biləcəyi xətalar
401 · 403 · 404 · 422