The fileAI API is REST over HTTPS. Every endpoint lives under /v1, takes and returns JSON, authenticates with an x-api-key header, and answers errors in one format. This page covers what all endpoints share; the pages below it describe each endpoint, with a Try it playground on every one.

​
Make a request

Hosthttps://api.orion.file.ai/prod

The default instance. Other regions only change the hostname; see Regions.

Version/v1

The only version. Changes inside it are additive; see Versioning.

Keyx-api-key: $FILEAI_API_KEY

A project key, or a personal key plus an x-project-id header. Create keys at the Developer Portal; see Authentication.

TraceX-Request-Id

On every response. Quote it to support; send your own to correlate.

The Developer Portal works with Developer Portal workspaces. If your workspace was set up in the fileAI app, create keys in the app instead: Settings → API Keys at orion.file.ai.
A quick check that your key and host are right is to ask which account the key belongs to. The call fails with 401 if the key is wrong, and otherwise names the project and workspace your requests land in:
A key only authenticates on the instance that issued it. If you get 401 with a key you know is valid, check the hostname before anything else.

​
Conventions

​
Endpoint groups

UploadsRequest a presigned URL, upload single files, batches and large files in parts, and track processing.8 endpointsFilesList and delete files, read extracted values and page text, correct values, re-run extraction and set export status.7 endpointsSchemas & file typesList schemas and file types, edit field definitions, approve, rename or delete file types, and import or export schemas.10 endpointsDocument jobsExtract, split or classify a document without storing it, then poll the job.4 endpointsForensicsRun fileForensics checks on a stored file, read the run, retry or delete it.5 endpointsFoldersCreate, list and delete folders, attach, remove and move files, and read checklist results.7 endpointsAgent sessionsAsk Minto questions about your files and read the answers turn by turn.7 endpointsPreviewsCreate file previews, one at a time or in a batch.2 endpointsQuery & workflowsRun a query builder configuration, read saved AI queries and read workflow results.5 endpointsAccountSee which key, project and workspace a request uses.1 endpointWorkspaceRead and update project defaults, and read your workspace subscription.3 endpoints

API quickstart

Upload a file and read its values end to end.

Production checklist

Everything to set up before you go live.