Patch a schema

curl --request PATCH \
  --url https://api.orion.file.ai/prod/v1/schemas \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "schemaId": "5f5f726eea75272d54e1e1e1",
  "fields": [
    {
      "id": "5f5f726eea75272d54e1e1e2",
      "title": "Title",
      "description": "Description",
      "type": "STRING",
      "format": "text",
      "hidden": false,
      "internet_context": false,
      "fieldSuggestion": {
        "id": "5f5f726eea75272d54e1e1e3",
        "name": "Field Suggestion"
      },
      "items": [],
      "value": "Value",
      "enumValues": [],
      "inlineListType": "SINGLE"
    }
  ]
}
'

import requests

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

payload = {
    "schemaId": "5f5f726eea75272d54e1e1e1",
    "fields": [
        {
            "id": "5f5f726eea75272d54e1e1e2",
            "title": "Title",
            "description": "Description",
            "type": "STRING",
            "format": "text",
            "hidden": False,
            "internet_context": False,
            "fieldSuggestion": {
                "id": "5f5f726eea75272d54e1e1e3",
                "name": "Field Suggestion"
            },
            "items": [],
            "value": "Value",
            "enumValues": [],
            "inlineListType": "SINGLE"
        }
    ]
}
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({
    schemaId: '5f5f726eea75272d54e1e1e1',
    fields: [
      {
        id: '5f5f726eea75272d54e1e1e2',
        title: 'Title',
        description: 'Description',
        type: 'STRING',
        format: 'text',
        hidden: false,
        internet_context: false,
        fieldSuggestion: {id: '5f5f726eea75272d54e1e1e3', name: 'Field Suggestion'},
        items: [],
        value: 'Value',
        enumValues: [],
        inlineListType: 'SINGLE'
      }
    ]
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schemaId' => '5f5f726eea75272d54e1e1e1',
    'fields' => [
        [
                'id' => '5f5f726eea75272d54e1e1e2',
                'title' => 'Title',
                'description' => 'Description',
                'type' => 'STRING',
                'format' => 'text',
                'hidden' => false,
                'internet_context' => false,
                'fieldSuggestion' => [
                                'id' => '5f5f726eea75272d54e1e1e3',
                                'name' => 'Field Suggestion'
                ],
                'items' => [
                                
                ],
                'value' => 'Value',
                'enumValues' => [
                                
                ],
                'inlineListType' => 'SINGLE'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"schemaId\": \"5f5f726eea75272d54e1e1e1\",\n  \"fields\": [\n    {\n      \"id\": \"5f5f726eea75272d54e1e1e2\",\n      \"title\": \"Title\",\n      \"description\": \"Description\",\n      \"type\": \"STRING\",\n      \"format\": \"text\",\n      \"hidden\": false,\n      \"internet_context\": false,\n      \"fieldSuggestion\": {\n        \"id\": \"5f5f726eea75272d54e1e1e3\",\n        \"name\": \"Field Suggestion\"\n      },\n      \"items\": [],\n      \"value\": \"Value\",\n      \"enumValues\": [],\n      \"inlineListType\": \"SINGLE\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.orion.file.ai/prod/v1/schemas")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemaId\": \"5f5f726eea75272d54e1e1e1\",\n  \"fields\": [\n    {\n      \"id\": \"5f5f726eea75272d54e1e1e2\",\n      \"title\": \"Title\",\n      \"description\": \"Description\",\n      \"type\": \"STRING\",\n      \"format\": \"text\",\n      \"hidden\": false,\n      \"internet_context\": false,\n      \"fieldSuggestion\": {\n        \"id\": \"5f5f726eea75272d54e1e1e3\",\n        \"name\": \"Field Suggestion\"\n      },\n      \"items\": [],\n      \"value\": \"Value\",\n      \"enumValues\": [],\n      \"inlineListType\": \"SINGLE\"\n    }\n  ]\n}")
  .asString();

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::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemaId\": \"5f5f726eea75272d54e1e1e1\",\n  \"fields\": [\n    {\n      \"id\": \"5f5f726eea75272d54e1e1e2\",\n      \"title\": \"Title\",\n      \"description\": \"Description\",\n      \"type\": \"STRING\",\n      \"format\": \"text\",\n      \"hidden\": false,\n      \"internet_context\": false,\n      \"fieldSuggestion\": {\n        \"id\": \"5f5f726eea75272d54e1e1e3\",\n        \"name\": \"Field Suggestion\"\n      },\n      \"items\": [],\n      \"value\": \"Value\",\n      \"enumValues\": [],\n      \"inlineListType\": \"SINGLE\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "message": "Invalid API key | API key is missing",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Access denied. You are in readonly mode.",
  "error": "Forbidden",
  "statusCode": 403
}

{
  "message": "Invalid schemaId | Invalid fields",
  "error": "Unprocessable Entity",
  "statusCode": 422
}

{
  "statusCode": 429,
  "message": "Too Many Requests"
}

Endpoints

Patch a schema

This endpoint is used to patch a schema.

The schemaId field is used to specify the schema that should be patched. The fields field is used to specify the fields that should be updated.

The fields field is an array of fields. Each field contains the following fields:

title: The title of the field. This is the human-readable name of the field.
description: The description of the field. This is a human-readable description of the field.
type: The type of the field. This can be either STRING, NUMBER, BOOLEAN, DATE, or OBJECT.
format: The format of the field. This is a string that indicates the format of the field.
hidden: Whether the field is hidden or not. This is a boolean value that indicates whether the field is hidden or not.
internet_context: Whether the field is internet context or not. This is a boolean value that indicates whether the field is internet context or not.
fieldSuggestion: The field suggestion of the field. This is an object that contains the following fields:
- id: The ID of the field suggestion. This is the unique identifier for the field suggestion.
- name: The name of the field suggestion. This is the human-readable name of the field suggestion.
items: The items of the field. This is an array of fields that are the items of the field.
value: The value of the field. This is the value of the field.
enumValues: The enum values of the field. This is an array of strings that are the enum values of the field.
inlineListType: The inline list type of the field. This is a string that indicates the inline list type of the field.

PATCH

prod

schemas

Patch a schema

curl --request PATCH \
  --url https://api.orion.file.ai/prod/v1/schemas \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "schemaId": "5f5f726eea75272d54e1e1e1",
  "fields": [
    {
      "id": "5f5f726eea75272d54e1e1e2",
      "title": "Title",
      "description": "Description",
      "type": "STRING",
      "format": "text",
      "hidden": false,
      "internet_context": false,
      "fieldSuggestion": {
        "id": "5f5f726eea75272d54e1e1e3",
        "name": "Field Suggestion"
      },
      "items": [],
      "value": "Value",
      "enumValues": [],
      "inlineListType": "SINGLE"
    }
  ]
}
'

import requests

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

payload = {
    "schemaId": "5f5f726eea75272d54e1e1e1",
    "fields": [
        {
            "id": "5f5f726eea75272d54e1e1e2",
            "title": "Title",
            "description": "Description",
            "type": "STRING",
            "format": "text",
            "hidden": False,
            "internet_context": False,
            "fieldSuggestion": {
                "id": "5f5f726eea75272d54e1e1e3",
                "name": "Field Suggestion"
            },
            "items": [],
            "value": "Value",
            "enumValues": [],
            "inlineListType": "SINGLE"
        }
    ]
}
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({
    schemaId: '5f5f726eea75272d54e1e1e1',
    fields: [
      {
        id: '5f5f726eea75272d54e1e1e2',
        title: 'Title',
        description: 'Description',
        type: 'STRING',
        format: 'text',
        hidden: false,
        internet_context: false,
        fieldSuggestion: {id: '5f5f726eea75272d54e1e1e3', name: 'Field Suggestion'},
        items: [],
        value: 'Value',
        enumValues: [],
        inlineListType: 'SINGLE'
      }
    ]
  })
};

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 => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'schemaId' => '5f5f726eea75272d54e1e1e1',
    'fields' => [
        [
                'id' => '5f5f726eea75272d54e1e1e2',
                'title' => 'Title',
                'description' => 'Description',
                'type' => 'STRING',
                'format' => 'text',
                'hidden' => false,
                'internet_context' => false,
                'fieldSuggestion' => [
                                'id' => '5f5f726eea75272d54e1e1e3',
                                'name' => 'Field Suggestion'
                ],
                'items' => [
                                
                ],
                'value' => 'Value',
                'enumValues' => [
                                
                ],
                'inlineListType' => 'SINGLE'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

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

	payload := strings.NewReader("{\n  \"schemaId\": \"5f5f726eea75272d54e1e1e1\",\n  \"fields\": [\n    {\n      \"id\": \"5f5f726eea75272d54e1e1e2\",\n      \"title\": \"Title\",\n      \"description\": \"Description\",\n      \"type\": \"STRING\",\n      \"format\": \"text\",\n      \"hidden\": false,\n      \"internet_context\": false,\n      \"fieldSuggestion\": {\n        \"id\": \"5f5f726eea75272d54e1e1e3\",\n        \"name\": \"Field Suggestion\"\n      },\n      \"items\": [],\n      \"value\": \"Value\",\n      \"enumValues\": [],\n      \"inlineListType\": \"SINGLE\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.orion.file.ai/prod/v1/schemas")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"schemaId\": \"5f5f726eea75272d54e1e1e1\",\n  \"fields\": [\n    {\n      \"id\": \"5f5f726eea75272d54e1e1e2\",\n      \"title\": \"Title\",\n      \"description\": \"Description\",\n      \"type\": \"STRING\",\n      \"format\": \"text\",\n      \"hidden\": false,\n      \"internet_context\": false,\n      \"fieldSuggestion\": {\n        \"id\": \"5f5f726eea75272d54e1e1e3\",\n        \"name\": \"Field Suggestion\"\n      },\n      \"items\": [],\n      \"value\": \"Value\",\n      \"enumValues\": [],\n      \"inlineListType\": \"SINGLE\"\n    }\n  ]\n}")
  .asString();

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::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"schemaId\": \"5f5f726eea75272d54e1e1e1\",\n  \"fields\": [\n    {\n      \"id\": \"5f5f726eea75272d54e1e1e2\",\n      \"title\": \"Title\",\n      \"description\": \"Description\",\n      \"type\": \"STRING\",\n      \"format\": \"text\",\n      \"hidden\": false,\n      \"internet_context\": false,\n      \"fieldSuggestion\": {\n        \"id\": \"5f5f726eea75272d54e1e1e3\",\n        \"name\": \"Field Suggestion\"\n      },\n      \"items\": [],\n      \"value\": \"Value\",\n      \"enumValues\": [],\n      \"inlineListType\": \"SINGLE\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true
}

{
  "message": "Invalid API key | API key is missing",
  "error": "Unauthorized",
  "statusCode": 401
}

{
  "message": "Access denied. You are in readonly mode.",
  "error": "Forbidden",
  "statusCode": 403
}

{
  "message": "Invalid schemaId | Invalid fields",
  "error": "Unprocessable Entity",
  "statusCode": 422
}

{
  "statusCode": 429,
  "message": "Too Many Requests"
}

The schemaId field is used to specify the schema that should be patched. The fields field is used to specify the fields that should be updated. The fields field is an array of fields. Each field contains the following fields:

title: The title of the field. This is the human-readable name of the field.
description: The description of the field. This is a human-readable description of the field.
type: The type of the field. This can be either STRING, NUMBER, BOOLEAN, DATE, or OBJECT.
format: The format of the field. This is a string that indicates the format of the field.
hidden: Whether the field is hidden or not. This is a boolean value that indicates whether the field is hidden or not.
internet_context: Whether the field is internet context or not. This is a boolean value that indicates whether the field is internet context or not.
fieldSuggestion: The field suggestion of the field. This is an object that contains the following fields:
id: The ID of the field suggestion. This is the unique identifier for the field suggestion.
name: The name of the field suggestion. This is the human-readable name of the field suggestion.
items: The items of the field. This is an array of fields that are the items of the field.
value: The value of the field. This is the value of the field.
enumValues: The enum values of the field. This is an array of strings that are the enum values of the field.
inlineListType: The inline list type of the field. This is a string that indicates the inline list type of the field.

Request Body

Parameter	Type	Required	Description
schemaId	string	Yes	Unique identifier of the schema to update
fields	array	Yes	Array of field objects to update or add

Field Object Structure

Each field in the fields array can contain the following properties:

Property	Type	Required	Description
title	string	No	Human-readable name of the field
description	string	No	Detailed description of the field’s purpose
type	string	No	Data type: STRING, NUMBER, BOOLEAN, DATE, or OBJECT
format	string	No	Specific format specification for the field
hidden	boolean	No	Whether the field should be hidden from display
internet_context	boolean	No	Whether the field relates to internet/web context
fieldSuggestion	object	No	Suggested values configuration
items	array	No	For array/list fields, defines the structure of list items
value	any	No	Default or current value of the field
enumValues	array	No	Array of allowed string values for enum fields
inlineListType	string	No	Type specification for inline list formatting

Field Object Structure

Each field in the fields array can contain the following properties:

Property	Type	Description
id	string	Unique identifier for the suggestion
name	string	Display name for the suggestion

Example Request

{
  "schemaId": "user-profile-schema-123",
  "fields": [
    {
      "title": "Full Name",
      "description": "User's complete name including first and last name",
      "type": "STRING",
      "hidden": false,
      "value": ""
    },
    {
      "title": "Age",
      "description": "User's age in years",
      "type": "NUMBER",
      "format": "integer",
      "hidden": false
    },
    {
      "title": "Account Status",
      "description": "Current status of the user account",
      "type": "STRING",
      "enumValues": ["active", "inactive", "suspended", "pending"],
      "fieldSuggestion": {
        "id": "status-suggestion-1",
        "name": "Account Status Options"
      }
    },
    {
      "title": "Preferences",
      "description": "User preference settings",
      "type": "OBJECT",
      "hidden": false,
      "items": [
        {
          "title": "Email Notifications",
          "type": "BOOLEAN",
          "value": true
        }
      ]
    }
  ]
}

Authorizations

x-api-key

string

header

required

API key for authentication

Body

application/json

The schema to patch

The body is of type string.

Response

The schema is patched

success

boolean

Get all schemas Get file type schemas

⌘I

fileAI API

Key Functions

Endpoints

Patch a schema

Request Body

Field Object Structure

Field Object Structure

Example Request

Authorizations

Body

Response

​Request Body

​Field Object Structure

​Field Object Structure

​Example Request

Authorizations

Body

Response

Request Body

Field Object Structure

Field Object Structure

Example Request