Start a Books Review run

Queues a Books Review run for a period (period_from to period_to, default this month; one date alone reads as on GET /v1/books-review) and depth (profile, default month_end), as the review page's Run, and answers 202 with status running, its correlation_key, period and profile; read the result with GET /v1/books-review once it is completed. The checks only read the books: a run writes its own results, its AI summary and history, never a journal, and the run is checked against the person's permissions again when it starts. When the company's Books Review schedule has email_after_manual_runs on, a finished run is also emailed to the schedule's recipients. One run at a time per company: while one is in flight a new start is a 409 books_review_run_in_progress with the running one's correlation_key in error.fields. A few runs per company and API client are admitted every five minutes (3 by default); past that the answer is 429 with Retry-After. Requires an Idempotency-Key: the same key and request replays the same 202 and never starts a second run. Requires the books-review:action OAuth scope with view_books_review and resolve_books_review.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Fields accepted to start a books review run. The schema identifies required and optional values.

date

First day of the period to review, YYYY-MM-DD. Default: the first day of period_to's month, else of this month

date

Last day of the period to review, YYYY-MM-DD, on or after period_from. Default: the last day of period_from's month, else of this month

string
enum

Review depth: quick, month_end or year_end. Default: month_end

Allowed:
Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*