Decisions
Extract values
Extract typed values from text and images.
POST
/
extractions
Extract typed values
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: '<string>',
input: '<string>',
fields: {},
images: [{base64: '<string>'}],
reference_date: '2023-12-25'
})
};
fetch('https://api.phaseo.app/v1/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.phaseo.app/v1/extractions"
payload = {
"model": "<string>",
"input": "<string>",
"fields": {},
"images": [{ "base64": "<string>" }],
"reference_date": "2023-12-25"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://api.phaseo.app/v1/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"input": "<string>",
"fields": {},
"images": [
{
"base64": "<string>"
}
],
"reference_date": "2023-12-25"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.phaseo.app/v1/extractions"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"input\": \"<string>\",\n \"fields\": {},\n \"images\": [\n {\n \"base64\": \"<string>\"\n }\n ],\n \"reference_date\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.phaseo.app/v1/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"<string>\",\n \"input\": \"<string>\",\n \"fields\": {},\n \"images\": [\n {\n \"base64\": \"<string>\"\n }\n ],\n \"reference_date\": \"2023-12-25\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.phaseo.app/v1/extractions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'model' => '<string>',
'input' => '<string>',
'fields' => [
],
'images' => [
[
'base64' => '<string>'
]
],
'reference_date' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.phaseo.app/v1/extractions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"<string>\",\n \"input\": \"<string>\",\n \"fields\": {},\n \"images\": [\n {\n \"base64\": \"<string>\"\n }\n ],\n \"reference_date\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"model": "<string>",
"answers": {},
"truncated": true,
"usage": {
"input_tokens": 1,
"output_tokens": 0,
"total_tokens": 1
}
}Extraction is in preview. Model availability depends on configured provider routes.
import { Phaseo } from "@phaseo/sdk";
const client = new Phaseo({ apiKey: process.env.PHASEO_API_KEY });
const result = await client.extractions.create({
model: "cloudflare/clairic",
input: "Invoice INV-2291: 4 pallets at $250 each, shipping $80.",
fields: {
invoice_number: { type: "text" },
total: { type: "number", decimals: 2, instructions: "Total including shipping" },
},
});
console.log(result.answers.total.value);
import os
from phaseo import Phaseo
client = Phaseo(api_key=os.environ["PHASEO_API_KEY"])
result = client.extractions.create({
"model": "cloudflare/clairic",
"input": "Invoice INV-2291: 4 pallets at $250 each, shipping $80.",
"fields": {"total": {"type": "number", "decimals": 2,
"instructions": "Total including shipping"}},
})
print(result["answers"]["total"]["value"])
AsyncPhaseo also exposes
await client.extractions.create(...).
Field types
Supported types aretext, number, date, time, datetime, duration and
list. Lists require items: "text", "number" or "date". Supply 1–64 fields
and at most 16,384 source characters. Field names start with a letter or underscore
and contain up to 64 letters, digits, underscores, dots or hyphens.
Numbers and durations support integer and decimals (0–6). Durations accept
seconds, minutes, hours, days, weeks, months or years. Set
reference_date when interpreting incomplete dates depends on a specific year.
Image inputs use { content_type, base64 } objects: at most four PNG/JPEG/WebP
images, 4 MiB each and 8 MiB combined after decoding. The request limit is 16 MiB.
Remote URLs, PDFs, audio, video, estimates, forecasts and streaming are unsupported.
Read answers
Readanswers[field_name].value. A scalar value can be null when the source does
not determine it. p_null is the model’s probability of an undetermined value;
confidence is a separate model-reported score. Lists provide confidence without
p_null. These scores do not guarantee correctness: choose review thresholds for
your workload. A valid empty list is different from a failed request.
truncated: true means the provider did not process all source input. Review or
resubmit shorter input before relying on completeness. Text offsets and raw guesses
are not exposed. Complex arithmetic should be performed in application code.
Usage reports aggregate input_tokens across provider passes. Output tokens are
zero. Use the gateway’s returned pricing rather than estimating cost from source
length or multiplying usage by the number of fields.Authorizations
Bearer token authentication
Body
application/json
Model ID with the extraction.extract capability.
Required string length:
1 - 256Source text. May be empty when images are supplied.
Maximum string length:
16384Field names match ^[A-Za-z_][A-Za-z0-9_.-]{0,63}$.
Show child attributes
Show child attributes
Embedded PNG, JPEG or WebP images; 4 MiB each and 8 MiB combined decoded.
Maximum array length:
4Show child attributes
Show child attributes
Explicit date context for incomplete dates.
Last modified on October 19, 2026
Was this page helpful?
⌘I
Extract typed values
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
model: '<string>',
input: '<string>',
fields: {},
images: [{base64: '<string>'}],
reference_date: '2023-12-25'
})
};
fetch('https://api.phaseo.app/v1/extractions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.phaseo.app/v1/extractions"
payload = {
"model": "<string>",
"input": "<string>",
"fields": {},
"images": [{ "base64": "<string>" }],
"reference_date": "2023-12-25"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)curl --request POST \
--url https://api.phaseo.app/v1/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"model": "<string>",
"input": "<string>",
"fields": {},
"images": [
{
"base64": "<string>"
}
],
"reference_date": "2023-12-25"
}
'package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.phaseo.app/v1/extractions"
payload := strings.NewReader("{\n \"model\": \"<string>\",\n \"input\": \"<string>\",\n \"fields\": {},\n \"images\": [\n {\n \"base64\": \"<string>\"\n }\n ],\n \"reference_date\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.post("https://api.phaseo.app/v1/extractions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"model\": \"<string>\",\n \"input\": \"<string>\",\n \"fields\": {},\n \"images\": [\n {\n \"base64\": \"<string>\"\n }\n ],\n \"reference_date\": \"2023-12-25\"\n}")
.asString();<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.phaseo.app/v1/extractions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'model' => '<string>',
'input' => '<string>',
'fields' => [
],
'images' => [
[
'base64' => '<string>'
]
],
'reference_date' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://api.phaseo.app/v1/extractions")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"model\": \"<string>\",\n \"input\": \"<string>\",\n \"fields\": {},\n \"images\": [\n {\n \"base64\": \"<string>\"\n }\n ],\n \"reference_date\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"model": "<string>",
"answers": {},
"truncated": true,
"usage": {
"input_tokens": 1,
"output_tokens": 0,
"total_tokens": 1
}
}