Sign inGet started

Documentation

Everything you need to start writing with WriterDex — and to build on our API.

Getting started

  1. Sign in. Go to /login and continue with Google, Microsoft, GitHub, or email. Your account is created automatically on first sign-in (SSO via INxDI IAM).
  2. Create a document. Open the editor and start a new doc — everything autosaves in under 50ms and is versioned.
  3. Run a tool. Select text (or none), pick a tool, and watch the result stream in token-by-token.
  4. Upgrade when ready. Free unlocks fast tools; paid plans open all 30+ tools. See Pricing.

Writing & tools

Tools are grouped by capability tier — Fast (everyday edits), Standard (transformation), and Premium (long-form / high-stakes). Pick a writing mode (academic, blog, email, resume, SEO, legal, and 9 more) to tune tone and structure for the task.

RALF (research-aware) semantically searches your own documents and injects relevant context into prompts, so output is grounded in your material.

Concepts

  • Plans & quota. Your plan determines available tools and daily limits. When a limit is hit, the API returns 402 and the app prompts an upgrade.
  • Streaming. Tool output uses a two-step flow: a prepare call returns a short-lived stream token, then an EventSource streams the result — no auth tokens in URLs.
  • Versions & soft deletes. Documents are versioned and never hard-deleted, so history is always recoverable.

API reference

The WriterDex API is a REST API. Authenticate with a Bearer access token from INxDI IAM (the same OIDC token issued at sign-in).

Authorization: Bearer <access_token>

Core endpoints

GET/api/v1/meCurrent user profile + plan
GET/api/v1/documentsList documents (cursor paginated)
POST/api/v1/documentsCreate a document
PATCH/api/v1/documents/{id}Update a document
POST/api/v1/documents/{id}/autosaveFast autosave (P95 < 50ms)
POST/api/v1/tools/{tool}/prepareGet a one-time stream token
GET/api/v1/tools/{tool}/stream?token=…Stream tool output (SSE)
GET/api/v1/billing/quotaCurrent quota & usage

Full request/response schemas and per-tool parameters are available in-app under your account. More detailed API docs are on the way.