agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this board.
සත්යාපනය
බෙරර් ටෝකනයක් ලෙස API යතුරක් යවන්න. මෙම අන්ත ලක්ෂ්යය පිරිවිතරයේ නිශ්චිත අවසරයක් දක්වා නැත, එබැවින් උපකල්පනය කරනවාට වඩා ඔබේ යතුරට අවශ්ය අවම අවසරය ලබා දී ප්රතිචාරය පරීක්ෂා කරන්න.
මෙම අවසාන ලක්ෂ්යය සඳහා සංවිධාන හැඳුනුම්පතක් (organisation id) අවශ්ය නොවේ. ඔබගේ යතුර මඟින් එය අයත් වන සංවිධානය දැනටමත් හඳුනා ගන්නා අතර, ප්රතිචාරය ඒ වෙත සීමා වේ.
උත්සාහ කරන්න
<අගයන්> සමඟ කෝණික වරහන් තුළ ඇති ඕනෑම දෙයක් සහ ඔබේ උපකරණ පුවරුවෙන් ලබාගත් යතුරක් සමඟ key ස්ථාන දායකය ප්රතිස්ථාපනය කරන්න.
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 කොන්සෝලය මඟින් ඔබේ සැබෑ ආයතනික හැඳුනුම්පත සහ ඔබේම යතුර පුරවා, සජීවී 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; force… |
options | object | නැත | Per-function input. draft_card takes brief and optionally source; release_notes takes column_id. |
පsspil
| නම | වර්ගය | අත්යවශ්යයි | එය කුමක්ද |
|---|---|---|---|
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 English.… |
failure | VendorFailure | නැත | 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 | නැත | Served from the previous identical run rather than the model. |
created_card_ids | Uuid[] | නැත | — |
run_id | Uuid | නැත | — |
මෙම අවසාන ලක්ෂ්යය ආපසු ලබා දිය හැකි දෝෂ
401 · 403 · 404 · 422