Skip to content
AEOptimiz

Using the REST API

Reading your workspace's data from your own scripts, with an API key.

The REST API gives your own scripts the same reads the assistant uses: Search Console history, index coverage, opportunities and reviews. It is read-only. Nothing it does spends credits or changes anything.

Create a key

  1. Open Settings, then Developer.
  2. Under REST API keys, name the key after what will use it, such as "Nightly export", and choose Create key.
  3. Copy the key straight away. It is shown once and never again: AEOptimiz keeps only a fingerprint of it.

You can hold 10 keys per workspace. A key stops working when you revoke it, or when you leave the workspace.

Make a request

Send the key as Authorization: Bearer followed by the key, or in an x-api-key header. Start by listing your sites, then ask a tool about one of them by its domain:

  • GET /api/v1/sites lists the workspace's sites.
  • POST /api/v1/tools/get_coverage with a JSON body such as {"site": "example.com"} answers about that site.

Every endpoint, with its fields and a ready-to-paste example, is in the API reference, generated from the same definitions the API runs on. The machine-readable OpenAPI document is at /api/v1/openapi.json.

Limits and errors

  • Each key can make 60 requests a minute. Past that the API answers 429, with a Retry-After header saying how long to wait.
  • A missing, revoked or unknown key is 401. A site that is not in the workspace, or an argument a tool cannot use, is 422.

Prefer an AI app?

To ask about your site from Claude, Cursor or another AI app instead of a script, connect it over MCP; see Using AEOptimiz from Claude, Cursor and other AI apps.