Creating an API key

You need the workspace owner role to manage API keys. Open Settings and go to API keys.

  1. Select Create a key.
  2. Enter a Name for the key so you can recognize it later (for example, a name that identifies the system that will use it).
  3. Choose whether to Allow this key to run checks, which grants the key permission to trigger a change check.
  4. Select Create a key to confirm.

Your new key is displayed once under Your new key. Copy it and store it somewhere safe. You won't be able to see it again after you select Done.

<aside> ⚠ The full key value is shown only at creation. If you lose it, revoke the key and create a new one; there is no way to retrieve the original value afterward.

</aside>

Each key belongs to a single workspace, so you don't need to send a workspace identifier when calling the API with it. The API keys list shows every key's name, its access, when it was created, and when it was last used, so you can confirm a key is actually in use before removing it.

Revoking a key

From the API keys list, select Revoke next to the key you want to disable. Confirm when asked Revoke this key?

The key's status changes to Revoked and it stops working immediately. Any request made with it afterward is rejected the same way an unknown or malformed key is rejected, so a revoked key gives no hint to whoever is holding it about why it failed.

What a key can access

An API key is read-only for your workspace's data: it can list corrections, repo check status, usage, and mapped docs, but it cannot approve, edit, or publish anything. A key never requests the Queue's actions on your behalf.

The one exception is the Allow this key to run checks scope, set when you create the key. With that scope, the key can trigger a change check through the API in addition to the read-only endpoints below. Without it, the key can read but cannot start a check.

<aside> ✏ Reading through the API does not count against anything restricted by your plan's trial or suspension state: usage and status endpoints follow the same access the dashboard has, so a lapsed subscription does not revoke read access. Revoke the key to stop that access.

</aside>

Calling the API

Every request needs your key as a bearer token in the Authorization header:

curl https://your-amendary-domain/api/v1/corrections \
  -H "Authorization: Bearer amk_your_key_here"

The following endpoints are available under /api/v1: