agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 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