agency-board

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

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

Semua titik akhir agency-board

Autentikasi

Kirimkan kunci API sebagai token bearer. Titik akhir ini tidak menyatakan izin tertentu dalam spesifikasi, jadi berikan kunci Anda izin minimum yang diperlukan dan periksa responsnya alih-alih berasumsi.

Endpoint ini tidak memerlukan id organisasi. Kunci Anda telah mengidentifikasi organisasi tempatnya berafiliasi, dan respons akan dibatasi untuk organisasi tersebut.

Coba

Ganti apa pun di dalam tanda kurung sudut dengan nilai Anda sendiri, dan placeholder kunci dengan kunci dari dasbor Anda.

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

Sudah masuk? Konsol API di dasbor Anda akan mengisi ID organisasi asli dan kunci Anda sendiri, serta menjalankan permintaan terhadap API langsung sehingga Anda dapat melihat respons aktualnya. Buka titik akhir ini di konsol API

Detail

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.

Parameter

NamaJenisWajibTentang apa ini
boardId (path)UuidYaProject board ID (UUIDv7).

Isi permintaan

NamaJenisWajibTentang apa ini
auto_triagebooleanTidak
auto_triage_appliesbooleanTidak
digest_cadencestring<off, daily, weekdays, weekly>Tidak
digest_hour_utcintegerTidak
preferred_providerstringTidak
preferred_modelstringTidak

Tanggapan

NamaJenisWajibTentang apa ini
board_idUuidYaUUIDv7 identifier — sortable by creation time (docs/02 §8).
auto_triagebooleanYaTriage a card when it lands in the intake column. Off by default.
auto_triage_appliesbooleanTidakApply 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>Ya
digest_hour_utcintegerTidak
digest_next_atstringTidak
digest_last_ok_atstringTidakWhen a digest last SUCCEEDED. Kept separate from `digest_next_at` deliberately: one column cannot serve both a cursor and a staleness alarm.
preferred_providerstringTidak
preferred_modelstringTidakBlank means the cheapest model we can run, computed from the price table.
entitledbooleanTidakWhether 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 `…

Kesalahan yang dapat dikembalikan oleh titik akhir ini

401 · 403 · 404 · 422