Rerun file form filling

curl --request PATCH \
  --url https://api.orion.file.ai/prod/v1/files/schema/rerun \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fileId": "8123612d-187c-44eb-8ac6-214e68506b7e",
  "backgroundRerun": true,
  "rerunOptions": {
    "paths": [
      "/discount_amount"
    ],
    "partialRerun": true
  }
}
'

import requests

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

payload = {
    "fileId": "8123612d-187c-44eb-8ac6-214e68506b7e",
    "backgroundRerun": True,
    "rerunOptions": {
        "paths": ["/discount_amount"],
        "partialRerun": True
    }
}
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: '8123612d-187c-44eb-8ac6-214e68506b7e',
    backgroundRerun: true,
    rerunOptions: {paths: ['/discount_amount'], partialRerun: true}
  })
};

fetch('https://api.orion.file.ai/prod/v1/files/schema/rerun', 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/files/schema/rerun",
  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([
    'fileId' => '8123612d-187c-44eb-8ac6-214e68506b7e',
    'backgroundRerun' => true,
    'rerunOptions' => [
        'paths' => [
                '/discount_amount'
        ],
        'partialRerun' => true
    ]
  ]),
  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/files/schema/rerun"

	payload := strings.NewReader("{\n  \"fileId\": \"8123612d-187c-44eb-8ac6-214e68506b7e\",\n  \"backgroundRerun\": true,\n  \"rerunOptions\": {\n    \"paths\": [\n      \"/discount_amount\"\n    ],\n    \"partialRerun\": true\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/files/schema/rerun")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileId\": \"8123612d-187c-44eb-8ac6-214e68506b7e\",\n  \"backgroundRerun\": true,\n  \"rerunOptions\": {\n    \"paths\": [\n      \"/discount_amount\"\n    ],\n    \"partialRerun\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orion.file.ai/prod/v1/files/schema/rerun")

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  \"fileId\": \"8123612d-187c-44eb-8ac6-214e68506b7e\",\n  \"backgroundRerun\": true,\n  \"rerunOptions\": {\n    \"paths\": [\n      \"/discount_amount\"\n    ],\n    \"partialRerun\": true\n  }\n}"

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

{
  "success": true
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "Invalid fileId.",
  "instance": "/v1/{route}",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [],
  "message": "Invalid fileId.",
  "error": "Unprocessable Entity",
  "statusCode": 422
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

Endpoints

Rerun file form filling

This endpoint is used to rerun the form filling of a file.

It is used to update the file fields based on the current file content and the current schema version.

The fileId field is used to specify the file that should be updated.

The backgroundRerun field is used to determine whether the form filling should be run in the background.

If set to true, the form filling will be run in the background. If set to false, the form filling will be run synchronously.

The rerunOptions field is used to specify the options for the form filling. The allowed fields are paths, partialRerun, and notification.

The paths field is used to specify the fields that should be updated. The fields that are specified in the paths field will be updated with the new schema fields.

The partialRerun field is used to determine whether the form filling should only be run for the modified fields.

If set to true, the form filling will only be run for the modified fields. If set to false, the form filling will be run for all fields.

The notification field is used to specify the notification options for the form filling. The allowed fields are shouldSendOnCompletion, referenceEntityName, referenceEntityId, and referenceEntityAction.

The shouldSendOnCompletion field is used to determine whether a notification should be sent when the form filling is completed.

If set to true, a notification will be sent when the form filling is completed. If set to false, no notification will be sent.

The referenceEntityName field is used to specify the name of the reference entity that should be used for the notification. The allowed values are FILE and SCHEMA.

The referenceEntityId field is used to specify the id of the reference entity that should be used for the notification.

The referenceEntityAction field is used to specify the action that should be used for the notification. The allowed values are CREATE, UPDATE, and DELETE.

PATCH

prod

files

schema

rerun

Rerun file form filling

curl --request PATCH \
  --url https://api.orion.file.ai/prod/v1/files/schema/rerun \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "fileId": "8123612d-187c-44eb-8ac6-214e68506b7e",
  "backgroundRerun": true,
  "rerunOptions": {
    "paths": [
      "/discount_amount"
    ],
    "partialRerun": true
  }
}
'

import requests

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

payload = {
    "fileId": "8123612d-187c-44eb-8ac6-214e68506b7e",
    "backgroundRerun": True,
    "rerunOptions": {
        "paths": ["/discount_amount"],
        "partialRerun": True
    }
}
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: '8123612d-187c-44eb-8ac6-214e68506b7e',
    backgroundRerun: true,
    rerunOptions: {paths: ['/discount_amount'], partialRerun: true}
  })
};

fetch('https://api.orion.file.ai/prod/v1/files/schema/rerun', 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/files/schema/rerun",
  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([
    'fileId' => '8123612d-187c-44eb-8ac6-214e68506b7e',
    'backgroundRerun' => true,
    'rerunOptions' => [
        'paths' => [
                '/discount_amount'
        ],
        'partialRerun' => true
    ]
  ]),
  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/files/schema/rerun"

	payload := strings.NewReader("{\n  \"fileId\": \"8123612d-187c-44eb-8ac6-214e68506b7e\",\n  \"backgroundRerun\": true,\n  \"rerunOptions\": {\n    \"paths\": [\n      \"/discount_amount\"\n    ],\n    \"partialRerun\": true\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/files/schema/rerun")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"fileId\": \"8123612d-187c-44eb-8ac6-214e68506b7e\",\n  \"backgroundRerun\": true,\n  \"rerunOptions\": {\n    \"paths\": [\n      \"/discount_amount\"\n    ],\n    \"partialRerun\": true\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.orion.file.ai/prod/v1/files/schema/rerun")

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  \"fileId\": \"8123612d-187c-44eb-8ac6-214e68506b7e\",\n  \"backgroundRerun\": true,\n  \"rerunOptions\": {\n    \"paths\": [\n      \"/discount_amount\"\n    ],\n    \"partialRerun\": true\n  }\n}"

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

{
  "success": true
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "Invalid fileId.",
  "instance": "/v1/{route}",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [],
  "message": "Invalid fileId.",
  "error": "Unprocessable Entity",
  "statusCode": 422
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

{
  "type": "https://errors.file.ai/validation-failed",
  "title": "Validation failed",
  "status": 422,
  "detail": "One or more fields are invalid.",
  "instance": "/v1/files/upload",
  "code": "VALIDATION_FAILED",
  "requestId": "0f1c8e03-978e-40d5-bc93-6894a57f9324",
  "errors": [
    {
      "code": "REQUIRED",
      "detail": "must not be empty",
      "pointer": "#/fileName",
      "parameter": "limit"
    }
  ],
  "message": "Validation failed",
  "error": "Unprocessable Entity",
  "statusCode": 422,
  "retryAfter": 42
}

It is used to update the file fields based on the current file content and the current schema version. The fileId field is used to specify the file that should be updated. The backgroundRerun field is used to determine whether the form filling should be run in the background.

If set to true, the form filling will be run in the background.
If set to false, the form filling will be run synchronously.

The rerunOptions field is used to specify the options for the form filling.

The allowed fields are paths, partialRerun, and notification.

The paths field is used to specify the fields that should be updated. The fields that are specified in the paths field will be updated with the new schema fields. The partialRerun field is used to determine whether the form filling should only be run for the modified fields.

If set to true, the form filling will only be run for the modified fields.
If set to false, the form filling will be run for all fields.

The notification field is used to specify the notification options for the form filling. The allowed fields are shouldSendOnCompletion, referenceEntityName, referenceEntityId, and referenceEntityAction. The shouldSendOnCompletion field is used to determine whether a notification should be sent when the form filling is completed.

If set to true, a notification will be sent when the form filling is completed.
If set to false, no notification will be sent.

The referenceEntityName field is used to specify the name of the reference entity that should be used for the notification. The allowed values are FILE and SCHEMA. The referenceEntityId field is used to specify the id of the reference entity that should be used for the notification. The referenceEntityAction field is used to specify the action that should be used for the notification. The allowed values are CREATE, UPDATE, and DELETE.

This endpoint accepts an optional Idempotency-Key request header so a retry cannot apply the change twice. See Idempotent requests.

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

Rerun file form filling input

The body is of type string.

Response

The file form filling is updated

success

boolean

⌘I

fileAI API

Key Functions

Endpoints

Rerun file form filling

Authorizations

Headers

Body

Response