Reports

Start a wording review of a report version

Changed on

Report review spec §8. Starts an async wording review (202): the version must be the report's and made by the current report builder (409 REPORT_NOT_REVIEWABLE) and hold written paragraphs (422 REPORT_REVIEW_NO_WRITTEN_TEXT). One review runs per version at a time (409 REPORT_REVIEW_RUNNING, details.runId). At most 30 reviews start per organisation per UTC day (429 REPORT_REVIEW_DAILY_LIMIT). Follow it with GET …/review every 2 s while run.status is pending or running. Reviews are free: no credit check, nothing debited; the tokens a reviewed run used are recorded unbilled for the caller's account. Needs report.edit_draft.

post/reports/{id}/versions/{versionId}/review/runs

Request

  • Base URL: https://api.greentally.ai/v1
  • URL: https://api.greentally.ai/v1/reports/{id}/versions/{versionId}/review/runs
  • Auth: HTTP bearer

Path parameters

idstring required
versionIdstring required

Response

The run, pending

Changes