API reference
The Typetone REST API: JSON over HTTPS, authenticated with an API key.
Base URL
Base URL
https://api.app.typetone.ai/public/v1Every endpoint lives under /v1.
Authentication
Send your API key in the X-API-Key header with every request. See Authentication for how to create one.
cURL
curl "https://api.app.typetone.ai/public/v1/audits" \
-H "X-API-Key: $TYPETONE_API_KEY"Requests and responses
- Request bodies are JSON: send
Content-Type: application/json. - Timestamps are ISO 8601 in UTC.
- List endpoints that can return many items are paged with
pageandpage_size, and returntotalandhas_more. - Errors return a
detailmessage. See Errors and limits.
OpenAPI specification
The full machine-readable spec is at api.app.typetone.ai/public/openapi.json. Import it into Postman, Insomnia or a code generator.
Endpoints
Audits and violations Read audit results and record review decisions. Read more → Tone of voice Your workspace's brand voices and their guidelines. Read more → Templates Content templates and the inputs they expect. Read more → Documents Generate content from a template. Read more → Knowledge bases Product facts and guidelines in your workspace. Read more → Health Check that the API is up. Read more →
Something unclear or missing? Tell us and we'll improve this page.