agency-board

POST `/v1/agency/boards/{boardId}/ai/run`

Run one AI function on this board.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

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>> }'

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`boardId (path)`	`Uuid`	Ndiyo	Project board ID (UUIDv7).

Mwili wa ombi

Jina	Aina	Inayohitajika	Kilicho hiki
`function`	`string<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked>`	Ndiyo	Which AI function to run.
`card_id`	`Uuid`	Hapana	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`apply`	`boolean`	Hapana	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`	Hapana	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`	Hapana	Per-function input. `draft_card` takes `brief` and optionally `source`; `release_notes` takes `column_id`.

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`function`	`string`	Ndiyo	—
`text`	`string`	Ndiyo	The output, or the reason it was skipped.
`payload`	`object`	Hapana	Structured result — labels, sub-tasks, candidate duplicates.
`model`	`string`	Hapana	The model that served it. Null on a skip, because none was chosen.
`provider`	`string`	Hapana	—
`funding`	`string<byo, credits, included>`	Hapana	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`	Hapana	The meter row, so board history and AI spend join up. Null on a skip.
`skipped`	`boolean`	Ndiyo	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`	Hapana	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>`	Hapana	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`	Hapana	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`	Hapana	`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`	Hapana	Served from the previous identical run rather than the model.
`created_card_ids`	`Uuid[]`	Hapana	—
`run_id`	`Uuid`	Hapana	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404 · 422

POST /v1/agency/boards/{boardId}/ai/run