Extract text from image
curl --request POST \
--url https://app.dumplingai.com/api/v1/extract-image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputMethod": "url",
"images": [
"https://example.com/receipt.jpg",
"https://example.com/menu.png"
],
"prompt": "Summarize the totals and highlight any discounts.",
"jsonMode": true
}
'import requests
url = "https://app.dumplingai.com/api/v1/extract-image"
payload = {
"inputMethod": "url",
"images": ["https://example.com/receipt.jpg", "https://example.com/menu.png"],
"prompt": "Summarize the totals and highlight any discounts.",
"jsonMode": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputMethod: 'url',
images: ['https://example.com/receipt.jpg', 'https://example.com/menu.png'],
prompt: 'Summarize the totals and highlight any discounts.',
jsonMode: true
})
};
fetch('https://app.dumplingai.com/api/v1/extract-image', 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://app.dumplingai.com/api/v1/extract-image",
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([
'inputMethod' => 'url',
'images' => [
'https://example.com/receipt.jpg',
'https://example.com/menu.png'
],
'prompt' => 'Summarize the totals and highlight any discounts.',
'jsonMode' => true
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.dumplingai.com/api/v1/extract-image"
payload := strings.NewReader("{\n \"inputMethod\": \"url\",\n \"images\": [\n \"https://example.com/receipt.jpg\",\n \"https://example.com/menu.png\"\n ],\n \"prompt\": \"Summarize the totals and highlight any discounts.\",\n \"jsonMode\": true\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://app.dumplingai.com/api/v1/extract-image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputMethod\": \"url\",\n \"images\": [\n \"https://example.com/receipt.jpg\",\n \"https://example.com/menu.png\"\n ],\n \"prompt\": \"Summarize the totals and highlight any discounts.\",\n \"jsonMode\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dumplingai.com/api/v1/extract-image")
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 \"inputMethod\": \"url\",\n \"images\": [\n \"https://example.com/receipt.jpg\",\n \"https://example.com/menu.png\"\n ],\n \"prompt\": \"Summarize the totals and highlight any discounts.\",\n \"jsonMode\": true\n}"
response = http.request(request)
puts response.read_body{
"results": "<string>",
"prompt": "<string>",
"imageCount": 123,
"creditUsage": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Document Processing
Extract Image
Perform OCR on images to extract text and metadata.
POST
/
api
/
v1
/
extract-image
Extract text from image
curl --request POST \
--url https://app.dumplingai.com/api/v1/extract-image \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"inputMethod": "url",
"images": [
"https://example.com/receipt.jpg",
"https://example.com/menu.png"
],
"prompt": "Summarize the totals and highlight any discounts.",
"jsonMode": true
}
'import requests
url = "https://app.dumplingai.com/api/v1/extract-image"
payload = {
"inputMethod": "url",
"images": ["https://example.com/receipt.jpg", "https://example.com/menu.png"],
"prompt": "Summarize the totals and highlight any discounts.",
"jsonMode": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
inputMethod: 'url',
images: ['https://example.com/receipt.jpg', 'https://example.com/menu.png'],
prompt: 'Summarize the totals and highlight any discounts.',
jsonMode: true
})
};
fetch('https://app.dumplingai.com/api/v1/extract-image', 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://app.dumplingai.com/api/v1/extract-image",
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([
'inputMethod' => 'url',
'images' => [
'https://example.com/receipt.jpg',
'https://example.com/menu.png'
],
'prompt' => 'Summarize the totals and highlight any discounts.',
'jsonMode' => true
]),
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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.dumplingai.com/api/v1/extract-image"
payload := strings.NewReader("{\n \"inputMethod\": \"url\",\n \"images\": [\n \"https://example.com/receipt.jpg\",\n \"https://example.com/menu.png\"\n ],\n \"prompt\": \"Summarize the totals and highlight any discounts.\",\n \"jsonMode\": true\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://app.dumplingai.com/api/v1/extract-image")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"inputMethod\": \"url\",\n \"images\": [\n \"https://example.com/receipt.jpg\",\n \"https://example.com/menu.png\"\n ],\n \"prompt\": \"Summarize the totals and highlight any discounts.\",\n \"jsonMode\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dumplingai.com/api/v1/extract-image")
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 \"inputMethod\": \"url\",\n \"images\": [\n \"https://example.com/receipt.jpg\",\n \"https://example.com/menu.png\"\n ],\n \"prompt\": \"Summarize the totals and highlight any discounts.\",\n \"jsonMode\": true\n}"
response = http.request(request)
puts response.read_body{
"results": "<string>",
"prompt": "<string>",
"imageCount": 123,
"creditUsage": 123
}{
"error": "<string>"
}{
"error": "<string>"
}Extract Image API Documentation
Description
This endpoint extracts structured data from image files based on a user-defined prompt. It supports input via URL or base64-encoded image content and uses vision-capable Large Language Models (LLMs) to interpret and extract relevant information from the images.Endpoint
POST https://app.dumplingai.com/api/v1/extract-image
Headers
- Content-Type:
application/json - Authorization: Bearer
<API_KEY>(required)
Request Body
{
"inputMethod": "string", // Required. Either "url" or "base64".
"images": ["string"], // Required. Array of URLs or base64-encoded image contents.
"prompt": "string", // Required. The prompt describing the data to extract.
"jsonMode": boolean // Optional. Whether to return the result in JSON format. Default: false.
}
Responses
Success (200)
Returns the extracted data based on the provided prompt, along with additional information.{
"results": "string", // Extracted data based on the prompt
"prompt": "string", // The original prompt used for extraction
"imageCount": number, // Number of images processed
"creditUsage": number // Total credits used for this request
}
- Content-Type: application/json
- X-RateLimit-Limit: The rate limit for the user.
- X-RateLimit-Remaining: The remaining number of requests for the user.
Bad Request (400)
Returned if the request is invalid or the total file size exceeds the limit.{
"error": "Error message describing the issue"
}
Unauthorized (401)
Returned if the API key is invalid or missing.{
"error": "Invalid or missing Authorization header"
}
Internal Server Error (500)
Returned if there’s an error during the image extraction process.{
"error": "Failed to extract image data: [error details]"
}
Example Request
curl -X POST https://app.dumplingai.com/api/v1/extract-image \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{
"inputMethod": "url",
"images": ["https://example.com/sample-image.jpg"],
"prompt": "Describe the main elements in this image.",
"jsonMode": false
}'
Notes
- The maximum total file size for all images combined is 100MB.
- The maximum file size for a single image is 20MB.
- The maximum number of images that can be processed in a single request is 3000.
- The maximum output is 8,192 tokens.
- Credit usage:
- Base cost: 100 credits
- Additional 10 credits per image processed
- The total credit usage is returned in the response as
creditUsage. - If using the URL method, ensure the image is publicly accessible.
- The
jsonModeparameter determines whether the output is formatted as JSON (true) or plain text (false). - Supported image formats: PNG, JPEG, WebP, HEIC, HEIF. Other formats will be automatically converted to PNG.
- Temporary files are created during processing and are deleted after use.
- You can get a list of supported image formats by calling:
GET /api/v1/extract-image
Rate Limiting
Rate limit headers (X-RateLimit-Limit and X-RateLimit-Remaining) are included in the response to indicate the user’s current rate limit status.
Error Handling
- If the required parameters (
imagesorprompt) are missing, a 400 Bad Request error is returned. - If the total file size exceeds 100MB, a 400 Bad Request error is returned.
- If there’s an error during extraction, a 500 Internal Server Error is returned with details about the failure.
Security and Privacy
- Uploaded images are temporarily stored and then deleted after processing.
- The endpoint uses the Gemini 1.5 Flash model for image analysis and data extraction.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Indicates whether binary content is supplied via URL or base64-encoded string.
Available options:
url, base64 Array of image URLs or base64-encoded strings to analyze.
Minimum array length:
1Instructions that describe the insights to extract from the images.
When true, requests the model to respond with JSON-formatted output.
Optional identifier describing where the API request originated.
Available options:
API, WEB, MAKE_DOT_COM, ZAPIER, N8N, PLAYGROUND, DEFAULT_AUTOMATION, AGENT_PREVIEW, AGENT_LIVE, AUTOPILOT, STUDIO