Skip to main content
GET
/
prod
/
v1
/
schemas
/
file-type
Get file type schemas
curl --request GET \
  --url https://api.orion.file.ai/prod/v1/schemas/file-type \
  --header 'x-api-key: <api-key>'
{
  "schemas": [
    {
      "id": "1",
      "fields": [],
      "blueprintId": "1",
      "originalSchemaId": "1",
      "schemaHistoryId": "1",
      "schemaHistoryVersionNumber": 1,
      "fileId": "1",
      "blueprintMode": "USER",
      "schemaType": "SYSTEM",
      "state": "ACTIVE",
      "usageApprovalState": "APPROVED",
      "schemaOverrideType": "NONE",
      "aiSchemaVersion": "1",
      "createdAt": "2021-01-01T00:00:00.000Z",
      "updatedAt": "2021-01-01T00:00:00.000Z",
      "deletedAt": null,
      "deletedBy": null
    }
  ],
  "count": 1,
  "currentPage": 1
}

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.

The response will contain a list of schemas that are associated with the file types in the workspace.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
blueprintId
string
required

Blueprint Id

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

​
blueprintMode
string

Blueprint Mode

Example:

"user"

​
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"

Response

The file type schemas is retrieved

​
schemas
object[]
​
count
number
​
currentPage
number