API Overview

What this page is for

This page explains the intent of the API and the kind of automation it is best suited for.

When to use it

Use it when:

• you are planning an integration
• you want to know whether the API is the right tool instead of the UI
• you need a simple mental model before reading endpoint-specific guidance

What the API is for

The API is there for automation and integration, not as a second copy of the product UI.

It is most useful when you want to:

• create reviews programmatically
• check review state from another system
• retrieve report output in an automated workflow

How to approach it

Start with the smallest useful integration:

1. create a review
2. poll for status
3. retrieve the output you need

What to expect

API access is authenticated with organization API keys, so treat those keys as operational credentials.

Common mistakes

• trying to automate everything at once
• treating the API like a replacement for learning the product workflow
• using poorly managed API keys for production integrations

Next step

• API keys
• Core review endpoints