agency-board
POST /v1/agency/boards/{boardId}/ai/run
Run one AI function on this 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 ಕನ್ಸೋಲ್ ನಿಮ್ಮ ನೈಜ ಸಂಸ್ಥೆಯ 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