Update a file's schema field definitions

PATCH

files

schema

curl --request PATCH \
  --url https://api.orion.file.ai/prod/v1/files/schema \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fileId": "f739da3b-d8cb-4f62-8174-4d387c28a5ac",
  "schemaId": "689eaa87aea205bcfc0f0201",
  "shouldCreateCustomIfNotExists": true,
  "schemaVersionType": "MINOR",
  "shouldChangeDocumentToNewSchemaVersion": true,
  "fieldPaths": [
    {
      "path": "/Receipt Number",
      "mode": "CREATE",
      "attributes": {
        "type": "string",
        "title": "Receipt Number",
        "hidden": false,
        "internet_context": false,
        "enumValues": [],
        "description": "Receipt Number"
      }
    }
  ]
}
'

import requests

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

payload = {
    "fileId": "f739da3b-d8cb-4f62-8174-4d387c28a5ac",
    "schemaId": "689eaa87aea205bcfc0f0201",
    "shouldCreateCustomIfNotExists": True,
    "schemaVersionType": "MINOR",
    "shouldChangeDocumentToNewSchemaVersion": True,
    "fieldPaths": [
        {
            "path": "/Receipt Number",
            "mode": "CREATE",
            "attributes": {
                "type": "string",
                "title": "Receipt Number",
                "hidden": False,
                "internet_context": False,
                "enumValues": [],
                "description": "Receipt Number"
            }
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileId: 'f739da3b-d8cb-4f62-8174-4d387c28a5ac',
    schemaId: '689eaa87aea205bcfc0f0201',
    shouldCreateCustomIfNotExists: true,
    schemaVersionType: 'MINOR',
    shouldChangeDocumentToNewSchemaVersion: true,
    fieldPaths: [
      {
        path: '/Receipt Number',
        mode: 'CREATE',
        attributes: {
          type: 'string',
          title: 'Receipt Number',
          hidden: false,
          internet_context: false,
          enumValues: [],
          description: 'Receipt Number'
        }
      }
    ]
  })
};

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

{
  "id": "689eaa87aea205bcfc0f0201",
  "fields": [
    {
      "id": "689eaa87aea205bcfc0f0201",
      "name": "Receipt Number",
      "type": "string",
      "title": "Receipt Number",
      "hidden": false,
      "internet_context": false,
      "enumValues": [],
      "description": "Receipt Number"
    }
  ],
  "blueprintId": "689eaa87aea205bcfc0f0201",
  "originalSchemaId": "689eaa87aea205bcfc0f0201",
  "schemaHistoryId": "689eaa87aea205bcfc0f0201",
  "schemaHistoryVersionNumber": 1,
  "fileId": "689eaa87aea205bcfc0f0201",
  "blueprintMode": "USER",
  "schemaType": "SYSTEM",
  "state": "ACTIVE",
  "usageApprovalState": "DRAFT",
  "schemaOverrideType": "NONE",
  "aiSchemaVersion": "v3",
  "createdAt": "2025-03-31T09:50:56.068Z",
  "updatedAt": "2025-03-31T09:50:56.068Z"
}

Request · Response · Guide: Extract fields

More details

The response will contain a list of schemas that are associated with the file types in the workspace.The fileId field is used to specify the file that should be changed to the new schema version.The schemaId field is used to specify the schema that should be updated.The shouldCreateCustomIfNotExists field is used to specify whether a custom schema should be created if it does not exist.The schemaVersionType field is used to specify the type of schema version to be create. The allowed values are MAJOR, MINOR, and PATCH.The shouldChangeDocumentToNewSchemaVersion field is used to specify whether the document should be changed to the new schema version.The fieldPaths field is used to specify the fields that should be updated.

Authorizations

x-api-key

string

header

required

API key for authentication

Headers

Idempotency-Key

string

Optional opaque key (max 255 chars, UUIDv4 recommended) making this request idempotent for 24h: a retry with the same key and body replays the original response with Idempotent-Replayed: true.

Body

application/json

Update file schema

The body is of type string.

Response

The schema is patched

string

fields

object[]

blueprintId

string

originalSchemaId

string

schemaHistoryId

string

schemaHistoryVersionNumber

number

fileId

string

blueprintMode

string

schemaType

string

state

string

usageApprovalState

string

schemaOverrideType

string

aiSchemaVersion

string

createdAt

string

updatedAt

string

deletedAt

string

deletedBy

string

Update a file's schema field definitions

curl --request PATCH \
  --url https://api.orion.file.ai/prod/v1/files/schema \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fileId": "f739da3b-d8cb-4f62-8174-4d387c28a5ac",
  "schemaId": "689eaa87aea205bcfc0f0201",
  "shouldCreateCustomIfNotExists": true,
  "schemaVersionType": "MINOR",
  "shouldChangeDocumentToNewSchemaVersion": true,
  "fieldPaths": [
    {
      "path": "/Receipt Number",
      "mode": "CREATE",
      "attributes": {
        "type": "string",
        "title": "Receipt Number",
        "hidden": false,
        "internet_context": false,
        "enumValues": [],
        "description": "Receipt Number"
      }
    }
  ]
}
'

import requests

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

payload = {
    "fileId": "f739da3b-d8cb-4f62-8174-4d387c28a5ac",
    "schemaId": "689eaa87aea205bcfc0f0201",
    "shouldCreateCustomIfNotExists": True,
    "schemaVersionType": "MINOR",
    "shouldChangeDocumentToNewSchemaVersion": True,
    "fieldPaths": [
        {
            "path": "/Receipt Number",
            "mode": "CREATE",
            "attributes": {
                "type": "string",
                "title": "Receipt Number",
                "hidden": False,
                "internet_context": False,
                "enumValues": [],
                "description": "Receipt Number"
            }
        }
    ]
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    fileId: 'f739da3b-d8cb-4f62-8174-4d387c28a5ac',
    schemaId: '689eaa87aea205bcfc0f0201',
    shouldCreateCustomIfNotExists: true,
    schemaVersionType: 'MINOR',
    shouldChangeDocumentToNewSchemaVersion: true,
    fieldPaths: [
      {
        path: '/Receipt Number',
        mode: 'CREATE',
        attributes: {
          type: 'string',
          title: 'Receipt Number',
          hidden: false,
          internet_context: false,
          enumValues: [],
          description: 'Receipt Number'
        }
      }
    ]
  })
};

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

{
  "id": "689eaa87aea205bcfc0f0201",
  "fields": [
    {
      "id": "689eaa87aea205bcfc0f0201",
      "name": "Receipt Number",
      "type": "string",
      "title": "Receipt Number",
      "hidden": false,
      "internet_context": false,
      "enumValues": [],
      "description": "Receipt Number"
    }
  ],
  "blueprintId": "689eaa87aea205bcfc0f0201",
  "originalSchemaId": "689eaa87aea205bcfc0f0201",
  "schemaHistoryId": "689eaa87aea205bcfc0f0201",
  "schemaHistoryVersionNumber": 1,
  "fileId": "689eaa87aea205bcfc0f0201",
  "blueprintMode": "USER",
  "schemaType": "SYSTEM",
  "state": "ACTIVE",
  "usageApprovalState": "DRAFT",
  "schemaOverrideType": "NONE",
  "aiSchemaVersion": "v3",
  "createdAt": "2025-03-31T09:50:56.068Z",
  "updatedAt": "2025-03-31T09:50:56.068Z"
}

Get started

Endpoints

Update a file's schema field definitions

Authorizations

Headers

Body

Response