Get all files

curl --request GET \
  --url https://api.orion.file.ai/prod/v1/files \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.orion.file.ai/prod/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orion.file.ai/prod/v1/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orion.file.ai/prod/v1/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.orion.file.ai/prod/v1/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "files": [
    {
      "fileId": "53d6a0b1-2a8d-4ed9-9e6a-ceaef7ca3908",
      "fileName": "file1.jpg",
      "fileType": "image/jpeg",
      "fileSize": 261928,
      "fileStoragePath": "path/to/file1.jpg",
      "fileHash": "be3ef5fbb21e31c1281300b23b1c918a8ba54427c799aea21865f68d5efd01b7",
      "uploadId": "f2538513-f0b9-4aa8-9c57-bc0a85c77de6",
      "status": "processed",
      "currency": "USD",
      "summary": "Example file",
      "referenceId": "1e70a5e860",
      "isDuplicate": false,
      "isEmbedded": false,
      "schemaId": "6835aca6030a79ffaabca742",
      "fileClass": "Receipt",
      "fileContactId": "6835aca2281d9ed1bab90b11",
      "fileContactName": "Example Company",
      "createdAt": "2025-05-27T12:14:24.258Z",
      "updatedAt": "2025-05-27T12:14:24.258Z",
      "directoryIds": [
        "6a0d8fa8e00fd1d2a80c6aa7",
        "6a0d8fa8e00fd1d2a80c6ab1"
      ],
      "exportInfo": {
        "integrationExportStatus": "completed",
        "integrationExportMessages": [
          "System successfully received result"
        ],
        "integrationExportUpdatedAt": "2025-05-27T14:30:00.000Z"
      }
    }
  ],
  "count": 1,
  "currentPage": 1
}

Endpoints

Get all files

Get all files of the current organization and workspace.

This endpoint is paginated. Use the page and limit query parameters to control pagination.

Alternatively, pass the cursor query parameter (empty for the first page) to use cursor pagination: the response envelope becomes { data, pagination: { limit, nextCursor, hasMore } } and pages are stable under concurrent writes. Follow nextCursor until hasMore is false; keep the same sort and filter parameters for every page of a walk.

Use the optional updatedAfter query parameter to filter files that have been updated on or after the specified timestamp (ISO 8601 format). Use the optional createdAfter query parameter to filter files that have been created on or after the specified timestamp (ISO 8601 format). These filters are useful for batch processes that need to fetch only files modified or created since the last sync.

Use the optional directoryId query parameter to return only files that belong to the specified directory (or sub-directory). Files in nested descendants are not included; pass the sub-directory id directly to fetch its files.

GET

prod

files

Get all files

curl --request GET \
  --url https://api.orion.file.ai/prod/v1/files \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.orion.file.ai/prod/v1/files', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.orion.file.ai/prod/v1/files",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.orion.file.ai/prod/v1/files"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.orion.file.ai/prod/v1/files")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "files": [
    {
      "fileId": "53d6a0b1-2a8d-4ed9-9e6a-ceaef7ca3908",
      "fileName": "file1.jpg",
      "fileType": "image/jpeg",
      "fileSize": 261928,
      "fileStoragePath": "path/to/file1.jpg",
      "fileHash": "be3ef5fbb21e31c1281300b23b1c918a8ba54427c799aea21865f68d5efd01b7",
      "uploadId": "f2538513-f0b9-4aa8-9c57-bc0a85c77de6",
      "status": "processed",
      "currency": "USD",
      "summary": "Example file",
      "referenceId": "1e70a5e860",
      "isDuplicate": false,
      "isEmbedded": false,
      "schemaId": "6835aca6030a79ffaabca742",
      "fileClass": "Receipt",
      "fileContactId": "6835aca2281d9ed1bab90b11",
      "fileContactName": "Example Company",
      "createdAt": "2025-05-27T12:14:24.258Z",
      "updatedAt": "2025-05-27T12:14:24.258Z",
      "directoryIds": [
        "6a0d8fa8e00fd1d2a80c6aa7",
        "6a0d8fa8e00fd1d2a80c6ab1"
      ],
      "exportInfo": {
        "integrationExportStatus": "completed",
        "integrationExportMessages": [
          "System successfully received result"
        ],
        "integrationExportUpdatedAt": "2025-05-27T14:30:00.000Z"
      }
    }
  ],
  "count": 1,
  "currentPage": 1
}

Get all files in the organization and workspace bound to your API key.

Query Parameters

Parameter	Type	Required	Default	Description
fileIds	string	No	—	Comma-separated file ids to fetch
directoryId	string	No	—	Return only files belonging to this directory
updatedAfter	string	No	—	Only files updated on or after this ISO 8601 timestamp
createdAfter	string	No	—	Only files created on or after this ISO 8601 timestamp
page	number	No	1	Page number for pagination
limit	number	No	100	Number of items per page
sortBy	string	No	`createdAt`	Field to sort by
sortOrder	string	No	`ASC`	Sort direction (`ASC` or `DESC`)
cursor	string	No	—	Opaque cursor. Send it (empty for the first page) to switch to cursor pagination.

This endpoint supports both pagination modes. Send the cursor parameter (empty value for the first page) to use cursor pagination; omit it entirely to keep the legacy page/limit response shape. See Pagination for the full comparison.

Filtering by directory

directoryId returns only files directly linked to that directory. Files in nested descendants are not included — pass the sub-directory id directly to fetch its files.

Examples use the default base URL, https://api.orion.file.ai/prod/v1. If your workspace is on an instance-specific host, swap the hostname and change nothing else — see Switching between instances.

curl -X GET "https://api.orion.file.ai/prod/v1/files?directoryId=68218006ebc72170fdb221f7" \
  -H "x-api-key: YOUR_API_KEY"

Incremental sync

updatedAfter and createdAfter let batch processes fetch only what changed since the last run. See Incremental Data Loading for the full Change Data Capture pattern.

curl -X GET "https://api.orion.file.ai/prod/v1/files?updatedAfter=2025-07-01T00:00:00.000Z" \
  -H "x-api-key: YOUR_API_KEY"

Pagination

Cursor (recommended)
Legacy page/limit

Send cursor to get a stable walk that is unaffected by concurrent writes. The response becomes { data, pagination }.

{
  "data": [{ "id": "649e2d2d2d2d2d2d2d2d2d2d" }],
  "pagination": { "limit": 50, "nextCursor": "eyJjcmVhdGVkQXQi...", "hasMore": true }
}

Follow nextCursor until hasMore is false, keeping the same sort and filter parameters for every page of the walk.

Omit cursor and the response keeps its original shape.

{
  "files": [{ "id": "649e2d2d2d2d2d2d2d2d2d2d" }],
  "count": 1350,
  "currentPage": 1
}

See Pagination for the full comparison.

Errors

A 422 is returned when updatedAfter or createdAfter is not a valid ISO 8601 timestamp. See Error responses.

Authorizations

x-api-key

string

header

required

API key for authentication

Query Parameters

fileIds

string

File Ids

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

updatedAfter

string

Filter files updated on or after this timestamp (ISO 8601 format)

Example:

"2025-01-01T00:00:00.000Z"

createdAfter

string

Filter files created on or after this timestamp (ISO 8601 format)

Example:

"2025-01-01T00:00:00.000Z"

directoryId

string

Filter files that belong to the given directory (or sub-directory) id. Only files directly linked to this directory are returned; descendants are not included.

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

page

number

default:1

Page number

Example:

1

limit

number

default:100

Number of items per page

Example:

100

sortBy

string

default:createdAt

Field to sort by

Example:

"createdAt"

sortOrder

enum<string>

default:ASC

Sort direction

Available options:

ASC,

DESC

Example:

"ASC"

cursor

string

Opaque pagination cursor. Provide the parameter (empty value for the first page) to switch to cursor pagination: the response becomes { data, pagination: { limit, nextCursor, hasMore } } with default limit 50 (max 100). Omit it entirely for legacy page/limit pagination. In cursor mode sortBy must be one of createdAt, updatedAt, _id, and cursors are bound to the sortBy/sortOrder they were minted with.

Response

The list of files is found. Offset mode (default) returns {files, count, currentPage}; cursor mode (when the cursor query parameter is present) returns {data, pagination}.

Option 1
Option 2

files

object[]

required

count

number

required

Total number of matching files

currentPage

number

required

⌘I

fileAI API

Key Functions

Endpoints

Get all files

Query Parameters

Filtering by directory

Incremental sync

Errors

Authorizations

Query Parameters

Response

​Query Parameters

​Filtering by directory

​Incremental sync

​Pagination

​Errors

Authorizations

Query Parameters

Response

Query Parameters

Filtering by directory

Incremental sync

Pagination

Errors