agency-board

PATCH /v1/agency/boards/{boardId}/ai/settings

Turn auto-triage or the standup digest on or off.

所有 agency-board 端点

身份验证

请将 API 密钥作为 bearer 令牌发送。此端点在规范中未指明具体的权限,因此请为您的密钥赋予所需的最小权限,并通过检查响应来确认,而不是盲目假设。

此端点不需要组织 ID。您的密钥已用于识别其所属的组织,且响应范围也仅限于该组织。

免费试用

将尖括号中的内容替换为您自己的值,并将键占位符替换为您仪表板中的一个键。

curl -X PATCH https://api.zinndigital.com/v1/agency/boards/{boardId}/ai/settings \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{  }'

已登录?您仪表板中的 API 控制台会自动填入您真实的组织 ID 和您自己的密钥,并针对实时 API 运行请求,以便您查看实际的响应。 在 API 控制台中打开此端点

详细信息

Both are **opt-in and off by default** — each is recurring billed work, so a board created for a test or an import must not start spending on a schedule nobody chose. Setting `digestCadence` to anything but `off` schedules the first digest; setting it to `off` clears the schedule.

参数

名称类型必填内容简介
boardId (path)UuidProject board ID (UUIDv7).

请求正文

名称类型必填内容简介
auto_triageboolean
auto_triage_appliesboolean
digest_cadencestring<off, daily, weekdays, weekly>
digest_hour_utcinteger
preferred_providerstring
preferred_modelstring

响应

名称类型必填内容简介
board_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
auto_triagebooleanTriage a card when it lands in the intake column. Off by default.
auto_triage_appliesbooleanApply the triage suggestions, or only propose them. Separate from `auto_triage` because "tell me what you think" and "do it" are different appetites.
digest_cadencestring<off, daily, weekdays, weekly>
digest_hour_utcinteger
digest_next_atstring
digest_last_ok_atstringWhen a digest last SUCCEEDED. Kept separate from `digest_next_at` deliberately: one column cannot serve both a cursor and a staleness alarm.
preferred_providerstring
preferred_modelstringBlank means the cheapest model we can run, computed from the price table.
entitledbooleanWhether 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 `…

此端点可能返回的错误

401 · 403 · 404 · 422