agency-board

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

Run one AI function on this board.

ਸਾਰੇ agency-board ਐਂਡਪੁਆਇੰਟ

ਪ੍ਰਮਾਣੀਕਰਨ

ਇੱਕ API ਕੁੰਜੀ ਨੂੰ ਬੀਅਰ ਟੋਕਨ ਵਜੋਂ ਭੇਜੋ। ਇਹ ਐਂਡਪੁਆਇੰਟ ਸਪੈਸੀਫਿਕੇਸ਼ਨ ਵਿੱਚ ਕਿਸੇ ਖਾਸ ਇਜਾਜ਼ਤ ਨੂੰ ਨਹੀਂ ਦਰਸਾਉਂਦਾ, ਇਸ ਲਈ ਆਪਣੀ ਕੁੰਜੀ ਨੂੰ ਘੱਟੋ-ਘੱਟ ਲੋੜੀਂਦੀਆਂ ਇਜਾਜ਼ਤਾਂ ਦਿਓ ਅਤੇ ਮੰਨਣ ਦੀ ਬਜਾਏ ਜਵਾਬ ਦੀ ਜਾਂਚ ਕਰੋ।

ਇਹ ਐਂਡਪੁਆਇੰਟ ਕੋਈ ਸੰਸਥਾ ਆਈਡੀ ਨਹੀਂ ਲੈਂਦਾ। ਤੁਹਾਡੀ ਕੁੰਜੀ ਪਹਿਲਾਂ ਹੀ ਉਸ ਸੰਸਥਾ ਦੀ ਪਛਾਣ ਕਰਦੀ ਹੈ ਜਿਸ ਨਾਲ ਇਹ ਸਬੰਧਤ ਹੈ, ਅਤੇ ਜਵਾਬ ਉਸੇ ਤੱਕ ਸੀਮਤ ਹੈ।

ਕੋਸ਼ਿਸ਼ ਕਰੋ

ਕੋਈ ਵੀ ਚੀਜ਼ ਜੋ ਕੋਣ ਵਾਲੇ ਬਰੈਕਟਾਂ ਵਿੱਚ ਹੈ ਉਸਨੂੰ ਆਪਣੇ ਖੁਦ ਦੇ ਮੁੱਲਾਂ ਨਾਲ ਬਦਲੋ, ਅਤੇ ਕੁੰਜੀ ਪਲੇਸਹੋਲਡਰ ਨੂੰ ਆਪਣੇ ਡੈਸ਼ਬੋਰਡ ਦੀ ਇੱਕ ਕੁੰਜੀ ਨਾਲ ਬਦਲੋ।

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 ਕੰਸੋਲ ਤੁਹਾਡੀ ਅਸਲ ਸੰਸਥਾ ਆਈਡੀ (organisation 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).

ਬੇਨਤੀ ਬਾਡੀ

ਨਾਮਕਿਸਮਲਾਜ਼ਮੀਕੀ ਹੈ ਇਹ
functionstring<draft_card, split_epic, summarise_card, summarise_board, triage_card, find_duplicates, release_notes, whats_blocked>ਹਾਂWhich AI function to run.
card_idUuidਨਹੀਂUUIDv7 identifier — sortable by creation time (docs/02 §8).
applybooleanਨਹੀਂ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.
forcebooleanਨਹੀਂ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…
optionsobjectਨਹੀਂPer-function input. `draft_card` takes `brief` and optionally `source`; `release_notes` takes `column_id`.

ਜਵਾਬ

ਨਾਮਕਿਸਮਲਾਜ਼ਮੀਕੀ ਹੈ ਇਹ
functionstringਹਾਂ
textstringਹਾਂThe output, or the reason it was skipped.
payloadobjectਨਹੀਂStructured result — labels, sub-tasks, candidate duplicates.
modelstringਨਹੀਂThe model that served it. Null on a skip, because none was chosen.
providerstringਨਹੀਂ
fundingstring<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_idUuidਨਹੀਂThe meter row, so board history and AI spend join up. Null on a skip.
skippedbooleanਹਾਂ**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_reasonstringਨਹੀਂMachine-readable cause, e.g. `AI_BUDGET_EXHAUSTED`, `AI_NOT_IN_GOOD_STANDING`, `not_enough_discussion`, `nothing_blocked`.
skip_kindstring<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_paramsobjectਨਹੀਂ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…
failureVendorFailureਨਹੀਂ`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…
cachedbooleanਨਹੀਂServed from the previous identical run rather than the model.
created_card_idsUuid[]ਨਹੀਂ
run_idUuidਨਹੀਂ

ਇਹ ਐਂਡਪੁਆਇੰਟ ਜੋ ਗਲਤੀਆਂ ਵਾਪਸ ਕਰ ਸਕਦਾ ਹੈ

401 · 403 · 404 · 422