Update project setting
curl --request PATCH \
--url https://api.orion.file.ai/prod/v1/project/setting \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"ocrModel": "Beethoven_ENG_O5.1",
"formTargetLanguage": "English",
"isSplit": false
}
'import requests
url = "https://api.orion.file.ai/prod/v1/project/setting"
payload = {
"ocrModel": "Beethoven_ENG_O5.1",
"formTargetLanguage": "English",
"isSplit": False
}
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({ocrModel: 'Beethoven_ENG_O5.1', formTargetLanguage: 'English', isSplit: false})
};
fetch('https://api.orion.file.ai/prod/v1/project/setting', 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/project/setting",
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([
'ocrModel' => 'Beethoven_ENG_O5.1',
'formTargetLanguage' => 'English',
'isSplit' => false
]),
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/project/setting"
payload := strings.NewReader("{\n \"ocrModel\": \"Beethoven_ENG_O5.1\",\n \"formTargetLanguage\": \"English\",\n \"isSplit\": false\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/project/setting")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ocrModel\": \"Beethoven_ENG_O5.1\",\n \"formTargetLanguage\": \"English\",\n \"isSplit\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orion.file.ai/prod/v1/project/setting")
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 \"ocrModel\": \"Beethoven_ENG_O5.1\",\n \"formTargetLanguage\": \"English\",\n \"isSplit\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true
}Endpoints
Update project setting
This endpoint is used to update the setting of the project.
The response will contain the updated setting of the project.
PATCH
/
prod
/
v1
/
project
/
setting
Update project setting
curl --request PATCH \
--url https://api.orion.file.ai/prod/v1/project/setting \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"ocrModel": "Beethoven_ENG_O5.1",
"formTargetLanguage": "English",
"isSplit": false
}
'import requests
url = "https://api.orion.file.ai/prod/v1/project/setting"
payload = {
"ocrModel": "Beethoven_ENG_O5.1",
"formTargetLanguage": "English",
"isSplit": False
}
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({ocrModel: 'Beethoven_ENG_O5.1', formTargetLanguage: 'English', isSplit: false})
};
fetch('https://api.orion.file.ai/prod/v1/project/setting', 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/project/setting",
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([
'ocrModel' => 'Beethoven_ENG_O5.1',
'formTargetLanguage' => 'English',
'isSplit' => false
]),
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/project/setting"
payload := strings.NewReader("{\n \"ocrModel\": \"Beethoven_ENG_O5.1\",\n \"formTargetLanguage\": \"English\",\n \"isSplit\": false\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/project/setting")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"ocrModel\": \"Beethoven_ENG_O5.1\",\n \"formTargetLanguage\": \"English\",\n \"isSplit\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orion.file.ai/prod/v1/project/setting")
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 \"ocrModel\": \"Beethoven_ENG_O5.1\",\n \"formTargetLanguage\": \"English\",\n \"isSplit\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true
}This endpoint accepts an optional
Idempotency-Key request header so a retry
cannot apply the change twice. See
Idempotent requests.Authorizations
API key for authentication
Headers
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
OCR model
Available options:
Beethoven_ENG_O5.1, Beethoven_ENG_G5.0, Beethoven_ENG_O5.1, Beethoven_ENG_O5.2, Beethoven_ENG_O5.3, Beethoven_ENG_O5.4, Beethoven_ENG_O5.5, Beethoven_ENG_O5.6, Beethoven_CUS_O5.1, Beethoven_ZH_O5.9, Beethoven_ENG_G5.2, Beethoven_ENG_G5.3, Beethoven_ENG_G5.4, Beethoven_ENG_G5.5, Beethoven_ENG_GP25.1, Unified (google-document-ai-ocr-gemini-v10), Beethoven_CUS_O5.2, Beethoven_ENG_GP25, Beethoven_ENG_GP25.2, Aegis (google-document-ai-ocr-gemini-aegis-v1), Beethoven_TH_O5.0, Beethoven_TH_O5.1, Beethoven_TH_G5.1, Beethoven_JP_O5.1, Beethoven_JP_O5.2, Beethoven_JP_O5.3, Beethoven_JP_G5.1, Beethoven_JP_G5.2, Beethoven_JP_G5.3, Beethoven_JP_G5.4, Beethoven_CUS_GP25.1, Beethoven_ENG_GP3, Beethoven_Direct_Form_Filling (GP2.5) Example:
"Beethoven_ENG_O5.1"
Form target language
Available options:
English, Afrikaans, Albanian, Amharic, Arabic, Armenian, Assamese, Azerbaijani, Basque, Belarusian, Bengali, Bosnian, Bulgarian, Burmese, Catalan, Cebuano, Chinese, Corsican, Croatian, Czech, Danish, Dutch, Esperanto, Estonian, Finnish, French, Frisian, Galician, Georgian, German, Greek, Gujarati, Haitian Creole, Hausa, Hawaiian, Hebrew, Hindi, Hmong, Hungarian, Icelandic, Igbo, Indonesian, Irish, Italian, Japanese, Javanese, Kannada, Kazakh, Khmer, Kinyarwanda, Korean, Kurdish, Kyrgyz, Laothian, Latin, Latvian, Lithuanian, Luxembourgish, Macedonian, Malagasy, Malay, Malayalam, Maltese, Maori, Marathi, Mongolian, Nepali, Norwegian, Nyanja, Oriya, Persian, Polish, Portuguese, Punjabi, Romanian, Russian, Samoan, Scots Gaelic, Serbian, Sesotho, Shona, Sinhalese, Slovak, Slovenian, Somali, Spanish, Sundanese, Swahili, Swedish, Tajik, Tamil, Tatar, Telugu, Thai, Tibetan, Tagalog, Turkish, Turkmen, Uighur, Ukrainian, Urdu, Uzbek, Vietnamese, Welsh, Wolof, Xhosa, Yiddish, Yoruba, Zulu Example:
"English"
Is split
Example:
false
Response
The project setting is updated