Clarity is a writing and productivity app that gives real-time feedback on structure and clarity. These docs cover core concepts, the HTTP API, and the plugin system.
Core Concepts
- Structure Coach: Guides you through sections, adds suggestions, and tracks progress.
- Clarity Score: A composite metric for structure, readability, and intent clarity.
- Tone Modes: Choose a style profile (academic, professional, narrative, etc.).
- Plugins: Optional, isolated extensions declared via a manifest and scoped permissions.
Authentication
Use your secret API key in the Authorization header. Keys can be created and revoked in your account settings.
curl -X POST https://api.clarity.app/v1/refine \
-H "Authorization: Bearer CLARITY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"text": "Write a concise project update about…",
"tone": "professional"
}'Webhooks
Configure webhooks to receive events like document.updated, score.updated, and plugin.run.completed.
POST /v1/webhooks
{
"url": "https://yourapp.com/clarity/webhooks",
"events": ["document.updated", "score.updated", "plugin.run.completed"]
}