Skip to main content
Our fileAI API is organized around REST and uses standard HTTP methods (POST, GET, PATCH) to interact with resource objects. It uses JSON as the primary data format, and all requests should have a Content-Type of application/json.

​
Key Features

These API endpoints are the building blocks for all your file ingestion needs. They can be used individually or in conjunction to create powerful end-to-end workflows.

File Upload & Management

Upload, retrieve and manage files in various formats in fileAI (includes sources, citations, location data and more)

Smart File Processing

Proprietary AI OCR with cross-file extraction and custom AI schemas

Dynamic AI Schemas

Auto-generated data structures that adapt to your files, fetch cross-file data (coming soon) and online data all in one workflow

Enterprise Ready

Secure, scalable, and built for production workloads (SOCII, ISO27001)

Easy Integration

RESTful API with callback URLs for real-time updates
Our fileAI API is organized around REST and uses standard HTTP methods (POST, GET, PATCH) to interact with resource objects. It uses JSON as the primary data format, and all requests should have a Content-Type of application/json.

​
Base URL and instances

The default base URL is:
Unless you have been told otherwise, this is the base URL to use, and it is the one every example in these docs is written against. fileAI also runs instance-specific hosts. An instance serves exactly the same API — identical paths, methods, parameters, request bodies and response schemas — and differs only in the hostname: So every endpoint in this reference is reached at:
Not sure whether your workspace is on an instance, or which one? Ask your account manager or contact support@file.ai.

​
Switching between instances

Because only the hostname changes, switching instances never means rewriting a request. Swap the host and everything else stays byte-for-byte identical.
Keep the base URL in one constant or environment variable and build every request path from it. Switching instances is then a one-line config change, not a search-and-replace.
A workspace belongs to exactly one instance, and an API key only authenticates against the host that issued it. Sending a request to a different instance fails authentication even though the endpoint exists there — so switch the base URL and the API key together.

​
Prerequisites for using the fileAI API

Before using our API, please ensure you complete the following prerequisites:

You must have a fileAI account

To use our API endpoints, you need to sign up or login here. Both self-serve and enterprise accounts are supported.

You must have an API Key

After creating your fileAI account, you can generate your API Key.

You must verify an AI Schema

fileAI suggests extraction and data fetch schemas. Confirm or edit these in the UI to call them directly via MCP.

​
How to get an API token

  1. Go to API Keys
  2. Click Create API Key
  3. Name the token, set expiration and permission
  4. Click Generate API Key
  5. Token will be shown, click Copy & Close
Note: Only admins can create API keys.

​
How to authorize an API token

  1. Once you have your API key, go to the API documentation page:
https://api.orion.file.ai/prod/v1/docs/swagger-uiOn an instance-specific host, swap the hostname — for example https://api.orion.sg.file.ai/prod/v1/docs/swagger-ui. See Base URL and instances.
  1. Click the Authorize button on the right of this page (the green Authorize button with lock icon)
  2. Enter your API Key under Value
  3. Click Authorize to start making authenticated requests directly from the documentation
If you need any further assistance, please reach out to our team at support@file.ai