agency-board
GET /v1/agency/boards/{boardId}/ai/settings
What AI this board has turned on.
Authentication
Send an API key as a bearer token. The endpoint checks agency.board.manage; a key without it is refused with 403, not 404.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X GET https://api.zinndigital.com/v1/agency/boards/{boardId}/ai/settings \
-H "Authorization: Bearer zdk_live_…"Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Parameters
| Name | Type | Required | What it is |
|---|---|---|---|
boardId (path) | Uuid | Yes | Project board ID (UUIDv7). |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
board_id | Uuid | Yes | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
auto_triage | boolean | Yes | Triage a card when it lands in the intake column. Off by default. |
auto_triage_applies | boolean | No | Apply the triage suggestions, or only propose them. Separate from auto_triage because "tell me what you think" and "do it" are different appetites. |
digest_cadence | string<off, daily, weekdays, weekly> | Yes | — |
digest_hour_utc | integer | No | — |
digest_next_at | string | No | — |
digest_last_ok_at | string | No | When a digest last SUCCEEDED. Kept separate from digest_next_at deliberately: one column cannot serve both a cursor and a staleness alarm. |
preferred_provider | string | No | — |
preferred_model | string | No | Blank means the cheapest model we can run, computed from the price table. |
entitled | boolean | No | Whether this organisation's plan includes board AI at all, so a client can stop offering what the engine would refuse. false means every run on this board answers 200 with… |
own_key | boolean | No | Whether this organisation holds a live BYO provider key. Present under exactly the same condition as entitled — both are omitted when the caller did not scope the question to an… |
Errors this endpoint can return
401 · 403 · 404