Skip to main content
GET
/
prod
/
v1
/
schemas
Get all schemas
curl --request GET \
  --url https://api.orion.file.ai/prod/v1/schemas \
  --header 'x-api-key: <api-key>'
{
  "schemas": [
    {
      "id": "5f5f726eea75272d54e1e1e1",
      "fields": [
        {
          "id": "5f5f726eea75272d54e1e1e2"
        }
      ],
      "blueprintId": "5f5f726eea75272d54e1e1e3",
      "originalSchemaId": "5f5f726eea75272d54e1e1e4",
      "schemaHistoryId": "5f5f726eea75272d54e1e1e5",
      "schemaHistoryVersionNumber": 1,
      "fileId": "5f5f726eea75272d54e1e1e6",
      "blueprintMode": "USER",
      "schemaType": "SYSTEM",
      "state": "ACTIVE",
      "usageApprovalState": "APPROVED",
      "schemaOverrideType": "OVERRIDE",
      "aiSchemaVersion": "5f5f726eea75272d54e1e1e7",
      "createdAt": "2020-10-05T14:30:00.000Z",
      "updatedAt": "2020-10-05T14:30:00.000Z",
      "deletedAt": null,
      "deletedBy": null
    }
  ],
  "count": 1,
  "currentPage": 1
}
The response will contain a list of all schemas that are available for the current user in the current workspace. The schemas field is an array of schemas. Each schema contains the following fields:
  • id: The ID of the schema. This is the unique identifier for the schema.
  • fields: An array of fields.
Each field contains the following fields:
  • id: The ID of the field. This is the unique identifier for the field.
  • blueprintId: The ID of the blueprint that the schema is associated with.
  • originalSchemaId: The ID of the original schema that the schema is based on.
  • schemaHistoryId: The ID of the schema history that the schema is associated with.
  • schemaHistoryVersionNumber: The version number of the schema history that the schema is associated with. This is a number that increments every time a new version of the schema is created.
  • fileId: The ID of the file that the schema is associated with.
  • blueprintMode: The mode of the blueprint that the schema is associated with. This can be either USER or SYSTEM.
  • schemaType: The type of the schema. This can be either SYSTEM, CUSTOM, or AI.
  • state: The state of the schema. This can be either ACTIVE or INACTIVE.
  • usageApprovalState: The state of the usage approval of the schema. This can be either APPROVED, PENDING, or REJECTED.
  • schemaOverrideType: The type of the schema override. This can be either OVERRIDE or DEFAULT.
  • aiSchemaVersion: The version of the AI schema that the schema is associated with.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
schemaIds
string

Schema Ids

Example:

"649e2d2d2d2d2d2d2d2d2d2d"

​
uploadIds
string

Upload Ids

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"

Response

The list of schemas

​
schemas
object[]
​
count
number
​
currentPage
number