API
Core Review Endpoints
The main API operations most teams need first when automating the review workflow.
What this page is for
This page explains the review lifecycle shape you should use when automating against the API.
When to use it
Use it when:
- you are building the first integration
- you want to keep the automation close to the way the product already works
- you need to know the minimum useful sequence of API operations
How to approach the workflow
Most teams only need three capabilities first:
- create a review
- check whether it is complete
- retrieve the output when it is ready
That maps directly to the way the product works in the UI.
Recommended sequence
- create the review
- poll or check the review state
- retrieve the report or follow-on data you need
What to expect
The cleanest API integrations mirror the real workflow rather than trying to invent a separate automation-only process.
Common mistakes
- building a large API integration before proving the basic review lifecycle
- trying to automate rare edge cases before the main path works
- forgetting that report availability may lag slightly behind review completion