Skip to main content
POST
/
prod
/
v1
/
files
/
schema
/
export
Export schemas
curl --request POST \
  --url https://api.orion.file.ai/prod/v1/files/schema/export \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "aiSchemaIds": "649e2d2d2d2d2d2d2d2d2d2d,649e2d2d2d2d2d2d2d2d2d2e"
}
'
{
  "exportedFileDownloadUrl": "<string>",
  "s3Path": "<string>",
  "fileName": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.file.ai/llms.txt

Use this file to discover all available pages before exploring further.

Export one or more schemas to a downloadable zip file. This endpoint allows you to backup or transfer your AI schemas between workspaces.
The exported zip file contains all schema definitions, field mappings, and related metadata needed to recreate the schemas.

​
How It Works

1

1. Select Schemas

Choose which schemas to export by providing their IDs
2

2. Export Request

Send the schema IDs to receive a pre-signed download URL
3

3. Download File

Use the pre-signed URL to download the exported zip file

​
Request Parameters

​
Request Body

The request body must contain a JSON object with the following property:
PropertyTypeRequiredDescription
aiSchemaIdsstringYesComma-separated list of schema IDs to export
Example Request Body: 
{
  "aiSchemaIds": "649e2d2d2d2d2d2d2d2d2d2d,649e2d2d2d2d2d2d2d2d2d2e"
}

​
Downloading the Exported File

The pre-signed download URL is valid for 1 hour only. Download the file promptly.
# Use the download URL from the response
curl -o exported-schemas.zip "https://s3.amazonaws.com/bucket/exported-schemas.zip?AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE&Signature=...&Expires=3600"

​
Export File Contents

The exported zip file contains:
  • Schema definitions - JSON files with field mappings and validation rules
  • Blueprint configurations - Document type classifications and extraction rules
  • Metadata - Creation timestamps, version information, and relationships
Exported schemas can be imported into other workspaces using the /prod/v1/files/schema/import endpoint.

​
Best Practices

  • Regular backups - Export schemas periodically to maintain backups
  • Workspace transfers - Use export/import to move schemas between workspaces
  • Version control - Keep track of exported files for schema versioning
  • Validate before import - Review exported contents before importing to new workspaces

Authorizations

​
x-api-key
string
header
required

API key for authentication

Body

application/json
​
aiSchemaIds
string
required

AISchemaIds IDs to export (comma-separated)

Example:

"649e2d2d2d2d2d2d2d2d2d2d,649e2d2d2d2d2d2d2d2d2d2e"

Response

Schemas exported successfully

​
exportedFileDownloadUrl
string
required

Exported file download URL

​
s3Path
string
required

S3 path of the exported file

​
fileName
string
required

File name