Quickstart

Create an API key, list your audits and read the violations of one audit. About five minutes.

1. Create an API key

In the Typetone app, go to Settings → MCP & API and create a key. Copy it right away: it’s shown only once.

Store it as an environment variable, so it stays out of your code:

Terminal

export TYPETONE_API_KEY="your-api-key"

Treat the key like a password. Anyone who has it can read your workspace’s audits and record review decisions. Revoke it under Settings → MCP & API if it leaks.

2. List your audits

curl "https://api.app.typetone.ai/public/v1/audits?limit=5" \
-H "X-API-Key: $TYPETONE_API_KEY"

import os
import requests

response = requests.get(
  "https://api.app.typetone.ai/public/v1/audits",
  params={"limit": 5},
  headers={"X-API-Key": os.environ["TYPETONE_API_KEY"]},
)
print(response.json())

const response = await fetch("https://api.app.typetone.ai/public/v1/audits?limit=5", {
headers: { "X-API-Key": process.env.TYPETONE_API_KEY },
});
console.log(await response.json());

You get the newest audits first, each with an id and a total_violations count.

3. Read the violations of an audit

Take an id from the previous response. By default you get the violations nobody has decided on yet:

cURL

curl "https://api.app.typetone.ai/public/v1/audits/AUDIT_ID/violations?page_size=10" \
-H "X-API-Key: $TYPETONE_API_KEY"

Each violation has the flagged text (violating_text), why it was flagged (reason), a recommended_solution and often a suggested_text you can use as a replacement.

4. Record a decision

cURL

curl -X POST "https://api.app.typetone.ai/public/v1/violations/VIOLATION_ID/review" \
-H "X-API-Key: $TYPETONE_API_KEY" \
-H "Content-Type: application/json" \
-d '{"action": "urgent_violation"}'

Open the audit in the Typetone app: the violation now shows as an urgent violation.

Next steps

Authentication: API keys and OAuth sign-in.
Audits and violations: every parameter and response field.
Connect Claude or ChatGPT: do the same in plain language.

Something unclear or missing? Tell us and we'll improve this page.