Get file schema values by fileIds
curl --request GET \
--url https://api.orion.file.ai/prod/v1/files/{fileId}/values \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orion.file.ai/prod/v1/files/{fileId}/values"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orion.file.ai/prod/v1/files/{fileId}/values', 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/{fileId}/values",
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/files/{fileId}/values"
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))
}HttpResponse<String> response = Unirest.get("https://api.orion.file.ai/prod/v1/files/{fileId}/values")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orion.file.ai/prod/v1/files/{fileId}/values")
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{
"values": {
"formValues": [
{
"id": "67ea5f20650d2fb5e33c1ffb",
"fileId": "7870a865-d560-4183-82c1-4b10e696e930_2",
"fileName": "7870a865-d560-4183-82c1-4b10e696e930_2.pdf",
"fileType": "application/pdf",
"createdAt": "2025-03-31T09:50:56.068Z",
"updatedAt": "2025-03-31T09:50:56.068Z",
"schemaRelationshipId": "67ea5f20650d2fb5e33c1ffb",
"schemaName": "Education Certificate",
"languageCode": null,
"originalBlueprintFormValuesId": null,
"fields": [
{
"title": "Degree",
"type": "string",
"description": "The degree obtained by the individual",
"format": null,
"hidden": false,
"value": "Bachelor of Mathematics",
"items": null
},
{
"title": "Department",
"type": "string",
"description": "The department where the degree was obtained",
"format": null,
"hidden": false,
"value": "Mathematics Department",
"items": null
}
],
"metadata": {
"createdBy": "67ea5edb650d2fb5e33c1ff2",
"userId": "67ea5edb650d2fb5e33c1ff2",
"organizationId": "67ea5f20650d2fb5e33c1ffb",
"workspaceId": "67ea5f07650d2fb5e33c1ff4"
}
}
],
"count": 1,
"currentPage": 1
}
}{
"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 fileId. | FileIds is required",
"error": "Unprocessable Entity",
"statusCode": 422
}{
"statusCode": 429,
"message": "Too Many Requests"
}Endpoints
Get file schema values by fileIds
Get file schema values by fileIds of the current organization and workspace.
This endpoint is paginated, you can use the page and limit query parameters to control the pagination.
For table/list fields with more than 100 rows, use includeFullTableData=true to retrieve all rows from S3 storage.
GET
/
prod
/
v1
/
files
/
{fileId}
/
values
Get file schema values by fileIds
curl --request GET \
--url https://api.orion.file.ai/prod/v1/files/{fileId}/values \
--header 'x-api-key: <api-key>'import requests
url = "https://api.orion.file.ai/prod/v1/files/{fileId}/values"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.orion.file.ai/prod/v1/files/{fileId}/values', 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/{fileId}/values",
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/files/{fileId}/values"
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))
}HttpResponse<String> response = Unirest.get("https://api.orion.file.ai/prod/v1/files/{fileId}/values")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orion.file.ai/prod/v1/files/{fileId}/values")
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{
"values": {
"formValues": [
{
"id": "67ea5f20650d2fb5e33c1ffb",
"fileId": "7870a865-d560-4183-82c1-4b10e696e930_2",
"fileName": "7870a865-d560-4183-82c1-4b10e696e930_2.pdf",
"fileType": "application/pdf",
"createdAt": "2025-03-31T09:50:56.068Z",
"updatedAt": "2025-03-31T09:50:56.068Z",
"schemaRelationshipId": "67ea5f20650d2fb5e33c1ffb",
"schemaName": "Education Certificate",
"languageCode": null,
"originalBlueprintFormValuesId": null,
"fields": [
{
"title": "Degree",
"type": "string",
"description": "The degree obtained by the individual",
"format": null,
"hidden": false,
"value": "Bachelor of Mathematics",
"items": null
},
{
"title": "Department",
"type": "string",
"description": "The department where the degree was obtained",
"format": null,
"hidden": false,
"value": "Mathematics Department",
"items": null
}
],
"metadata": {
"createdBy": "67ea5edb650d2fb5e33c1ff2",
"userId": "67ea5edb650d2fb5e33c1ff2",
"organizationId": "67ea5f20650d2fb5e33c1ffb",
"workspaceId": "67ea5f07650d2fb5e33c1ff4"
}
}
],
"count": 1,
"currentPage": 1
}
}{
"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 fileId. | FileIds is required",
"error": "Unprocessable Entity",
"statusCode": 422
}{
"statusCode": 429,
"message": "Too Many Requests"
}Authorizations
API key for authentication
Path Parameters
Query Parameters
Page number
Example:
1
Number of items per page
Example:
100
Field to sort by
Example:
"createdAt"
Sort direction
Available options:
ASC, DESC Example:
"ASC"
Response
The file schema values are retrieved
Show child attributes
Show child attributes
⌘I