Get all schemas

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

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

fetch('https://api.orion.file.ai/prod/v1/schemas', 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/schemas",
  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/schemas"

	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/schemas")

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

{
  "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"
    }
  ],
  "count": 1,
  "currentPage": 1
}

Endpoints

Get all schemas

This endpoint is used to get all schemas.

The response will contain a list of all schemas that are available for the current user in the current workspace.

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

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.
createdAt: The date and time when the schema was created.
updatedAt: The date and time when the schema was last updated.
deletedAt: The date and time when the schema was deleted.
deletedBy: The ID of the user who deleted the schema.

GET

prod

schemas

Get all schemas

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

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

fetch('https://api.orion.file.ai/prod/v1/schemas', 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/schemas",
  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/schemas"

	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/schemas")

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

{
  "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"
    }
  ],
  "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.

Query Parameters

Parameter	Type	Required	Default	Description
schemaIds	string	No	—	Comma-separated schema ids to fetch
uploadIds	string	No	—	Comma-separated upload ids to fetch schemas for
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.

In cursor mode the response becomes { data, pagination: { limit, nextCursor, hasMore } }. 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 { schemas, count, currentPage } shape.

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"

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 schemas. Offset mode (default) returns {schemas, count, currentPage}; cursor mode (when the cursor query parameter is present) returns {data, pagination}.

Option 1
Option 2

schemas

object[]

required

count

number

required

Total number of matching schemas

currentPage

number

required

⌘I

fileAI API

Key Functions

Endpoints

Get all schemas

Query Parameters

Authorizations

Query Parameters

Response

​Query Parameters

Authorizations

Query Parameters

Response

Query Parameters