REST API authentication

Every REST API overview request must include a valid API key. This topic covers how to generate, use, rotate, and revoke keys.

Before you begin #

Generate an API key #

1. Go to Settings in the sidebar.

2. Open the API Keys tab.

3. Click Generate API Key.

4. Give the key a descriptive name, for example, "CI/CD pipeline" or "Zendesk sync."

5. Copy the key immediately.

Use the key #

Include the key as a Bearer token in the Authorization header of every request:

curl https://topicary.com/api/v1/topics \
  -H "Authorization: Bearer tk_your_api_key_here"

const res = await fetch("https://topicary.com/api/v1/topics", {
  headers: { Authorization: "Bearer tk_your_api_key_here" },
});

import requests

res = requests.get(
    "https://topicary.com/api/v1/topics",
    headers={"Authorization": "Bearer tk_your_api_key_here"},
)

All keys are prefixed with tk_ for easy identification in logs and configuration files.

Key scoping #

Each API key is scoped to the project where it was created. A key cannot access data in other projects, even if the creator belongs to multiple projects.

Rotate a key #

To rotate a key without downtime:

1. Generate a new key.

2. Update your integration to use the new key.

3. Verify the integration works with the new key.

4. Revoke the old key.

Revoke a key #

1. Go to Settings > API Keys.

2. Find the key in the list.

3. Click Revoke.

4. Confirm the revocation.

Revocation is immediate. Any request using the revoked key returns a 401 Unauthorized error.

See also #

• REST API overview: base URL, rate limits, and response format

• REST API endpoints: full endpoint reference

• Security and data handling: how API keys are hashed and stored

• Plans and limits: API keys require a Business plan