OpenAPI / Swagger

The API service exposes a machine-readable OpenAPI 3.1 specification and an interactive Swagger UI.

Interactive Swagger UI

The Swagger UI is available at:

https://sapi.i18nme.com/docs

You can authorize with your API key via the Authorize button (top right), then call any endpoint directly from the browser.

Raw OpenAPI spec

https://sapi.i18nme.com/openapi.json

Download and import into any OpenAPI-compatible tool (Postman, Insomnia, Stoplight, etc.).

Import into Postman

1. Open Postman → Import → Link
2. Paste https://sapi.i18nme.com/openapi.json
3. Click Import
4. Open the collection → Variables → set baseUrl and X-API-Key

Import into Insomnia

1. File → Import → URL
2. Enter https://sapi.i18nme.com/openapi.json
3. Create an environment variable api_key with your key value
4. Add X-API-Key: to the collection-level headers

Generate a typed client

TypeScript (openapi-typescript)

npx openapi-typescript https://sapi.i18nme.com/openapi.json -o src/types/api.d.ts

Python (openapi-python-client)

pip install openapi-python-client
openapi-python-client generate --url https://sapi.i18nme.com/openapi.json

OpenAPI version

The spec follows OpenAPI 3.1.0. It is generated automatically by FastAPI from the route definitions and Pydantic models — it is always in sync with the running API.

Local development

When running the API service locally (non-production mode), the following URLs are available:

URL	Purpose
http://localhost:8001/docs	Interactive Swagger UI
http://localhost:8001/redoc	ReDoc documentation
http://localhost:8001/openapi.json	Raw OpenAPI 3.1 spec
http://localhost:8001/v1/spec	Redirect shortcut → /openapi.json

Note: In production these URLs are disabled. Use the production URLs above for the live spec.