← Docs

API overview

The Schreibly API is a small, focused interface for sending text and getting back a list of suggested changes. Full reference documentation will be published when the API leaves private beta.

Endpoints (high level)

• POST /v1/check — submit text and get suggestions back.
• GET /v1/wallet — read your remaining word balance and expiry.
• GET /v1/variants — list supported variants.

Authentication

API keys are issued from the dashboard, scoped to a single account or organisation. They are sent as a Bearer token in the Authorization header.

What counts as a word

A "word" is a sequence of characters separated by whitespace or punctuation, as your text is segmented for analysis. Submitting a document of 1,000 words deducts 1,000 from your wallet, whether or not any issues are found.

Rate limits

Reasonable rate limits apply to prevent abuse. They're well above what an interactive client needs. If you're building something that needs more, contact us — see the Acceptable Use Policy.

Privacy and data handling

Text you send to the API is processed to perform the check, then discarded (with short-lived caching to speed up repeat checks). We do not use your text to train models without consent. See the Privacy Policy.

Status

The API is in private beta. To request access, write to support@codexo.dev.