Skip to content

Documentation

Build with FastVision

REST API, six SDKs, and an interactive reference generated straight from the OpenAPI schema. Everything below works identically self-hosted.

API reference

Browse and try the whole API, live

The interactive reference is generated straight from the running API, so it's always current. No account or repo access needed.

Quickstart

Zero to extracted text in three steps

1

Create an account & API key

Register, then mint a key from Dashboard → API keys. Keys look like fv_live_… and are shown once — store them like passwords.

export FASTVISION_API_KEY="fv_live_yourkeyhere"
2

Submit your first document

POST a file to /api/v1/ocr/image. The API responds instantly with 202 and a job resource.

curl -X POST https://api-production-5bb4.up.railway.app/api/v1/ocr/image \
  -H "X-API-Key: $FASTVISION_API_KEY" \
  -F "file=@receipt.png" -F "doc_type=receipt"
3

Fetch the result

Poll the job until status is succeeded, or register a webhook and let job.completed come to you.

curl https://api-production-5bb4.up.railway.app/api/v1/jobs/{id}/result \
  -H "X-API-Key: $FASTVISION_API_KEY"