create
curl --request POST \
--url https://api.withflora.io/v1/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form schema_id=ec9cb821-6f69-4605-a7fc-0858667eb534 \
--form type=image \
--form model=gpt-4.1 \
--form source=https://8ddf98.jpgimport requests
url = "https://api.withflora.io/v1/extractions"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('schema_id', 'ec9cb821-6f69-4605-a7fc-0858667eb534');
form.append('type', 'image');
form.append('model', 'gpt-4.1');
form.append('source', 'https://8ddf98.jpg');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.withflora.io/v1/extractions', 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.withflora.io/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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.withflora.io/v1/extractions"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.withflora.io/v1/extractions")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflora.io/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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"id": "c39c0c98-d71c-471c-a7e0-6e3fcf2f8298",
"output": {
"amount": 38580,
"currency": "NGN",
"products": [
{
"amount": 1600,
"name": "Chicken Pie",
"quantity": 2
},
{
"amount": 3750,
"name": "Ayoola Poundo Yam",
"quantity": 1
},
{
"amount": 5000,
"name": "Seedless Grape",
"quantity": 1
}
],
"storeName": "XYZ Superstores"
},
"totalTokens": 1795
},
"message": "Extraction completed successfully",
"status": true
}Extractions
Create Extraction
Extract data from an unstructured source using a schema
POST
/
extractions
create
curl --request POST \
--url https://api.withflora.io/v1/extractions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form schema_id=ec9cb821-6f69-4605-a7fc-0858667eb534 \
--form type=image \
--form model=gpt-4.1 \
--form source=https://8ddf98.jpgimport requests
url = "https://api.withflora.io/v1/extractions"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('schema_id', 'ec9cb821-6f69-4605-a7fc-0858667eb534');
form.append('type', 'image');
form.append('model', 'gpt-4.1');
form.append('source', 'https://8ddf98.jpg');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.withflora.io/v1/extractions', 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.withflora.io/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 => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: multipart/form-data"
],
]);
$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.withflora.io/v1/extractions"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.withflora.io/v1/extractions")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.withflora.io/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.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"schema_id\"\r\n\r\nec9cb821-6f69-4605-a7fc-0858667eb534\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nimage\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\ngpt-4.1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"source\"\r\n\r\nhttps://8ddf98.jpg\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": {
"id": "c39c0c98-d71c-471c-a7e0-6e3fcf2f8298",
"output": {
"amount": 38580,
"currency": "NGN",
"products": [
{
"amount": 1600,
"name": "Chicken Pie",
"quantity": 2
},
{
"amount": 3750,
"name": "Ayoola Poundo Yam",
"quantity": 1
},
{
"amount": 5000,
"name": "Seedless Grape",
"quantity": 1
}
],
"storeName": "XYZ Superstores"
},
"totalTokens": 1795
},
"message": "Extraction completed successfully",
"status": true
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data
The schema ID. Create a schema first using the POST /schemas endpoint.
Example:
"ec9cb821-6f69-4605-a7fc-0858667eb534"
The input type can be any of text, image, pdf, and webpage.
Example:
"image"
Optional. Can be either 'gpt-4o' or 'gpt-4o-mini', we will use 'gpt-4o' by default
Available options:
gpt-4.1, gpt-4.1-mini Example:
"gpt-4.1"
When type is: PDF - Pass a valid and accesible pdf url
Image - Pass a valid and accesible image url
Webpage - Pass a valid and accesible webpage url
Text - Text content to extract data from
Example:
"https://8ddf98.jpg"
Was this page helpful?