agency-board

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

Run one AI function on this board.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության 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; `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…
`cached`	`boolean`	Ոչ	Served from the previous identical run rather than the model.
`created_card_ids`	`Uuid[]`	Ոչ	—
`run_id`	`Uuid`	Ոչ	—

Այս վերջնակետի կողմից վերադարձվող սխալները

401 · 403 · 404 · 422

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