Quickstart

Get up and running with Francis in under a minute. Make your first language detection or translation request.

1. Get an API key

Terminalbash

curl -X POST 'https://francis.verbatims.cc/api/v1/keys' \
  -H 'Authorization: Bearer <session_token>' \
  -d '{"name": "My First Key"}'

Or sign in to the dashboard to generate a key with one click.

2. Detect a language

Send a POST request to /api/v1/detect with your text and API key.

Terminalbash

$ curl -X POST 'https://francis.verbatims.cc/api/v1/detect' \
  -H 'x-api-key: fcs_a1b2c3d4...' \
  -d '{"text": "Hello world"}'

{ "language": "eng", "confidence": 0.97, "alternatives": ["spa", "fra"] }

3. Translate text

Translate text into one or more languages with a single POST /api/v1/translate request.

Terminalbash

$ curl -X POST 'https://francis.verbatims.cc/api/v1/translate' \
  -H 'x-api-key: fcs_a1b2c3d4...' \
  -d '{"text": "Hello world", "target": ["fr", "es", "ja"]}'

{ "translations": [{ "target": "fr", "text": "Bonjour le monde" }], "model": "openai/gpt-4o-mini" }

4. Monitor usage

Track your daily request volume per API key through the dashboard or via the GET /api/v1/usage endpoint. Each key has a configurable daily limit, and usage is counted atomically with every request.

Open Dashboard

Ready to dive deeper?

Full endpoint documentation, request schemas, and error codes.

API Reference