Pipeline
import requests
url = "https://platform.reducto.ai/pipeline"
payload = {
"document_url": "<string>",
"pipeline_id": "<string>",
"settings": {}
}
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({document_url: '<string>', pipeline_id: '<string>', settings: {}})
};
fetch('https://platform.reducto.ai/pipeline', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.reducto.ai/pipeline"
payload := strings.NewReader("{\n \"document_url\": \"<string>\",\n \"pipeline_id\": \"<string>\",\n \"settings\": {}\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))
}{
"job_id": "<string>",
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
},
"result": {
"parse": {
"job_id": "<string>",
"duration": 123,
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
},
"result": {
"type": "<string>",
"chunks": [
{
"content": "<string>",
"embed": "<string>",
"enriched": "<string>",
"blocks": [
{
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"content": "<string>",
"image_url": "<string>",
"chart_data": [
"<string>"
],
"confidence": "low",
"granular_confidence": {
"extract_confidence": 123,
"parse_confidence": 123
},
"merged_tables": [
{
"content": "<string>",
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"image_url": "<string>"
}
],
"extra": {}
}
],
"enrichment_success": false
}
],
"ocr": {
"words": [
{
"text": "<string>",
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"confidence": 123,
"chunk_index": 123,
"rotation": 123
}
],
"lines": [
{
"text": "<string>",
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"confidence": 123,
"chunk_index": 123,
"rotation": 123
}
]
},
"custom": null
},
"response_type": "parse",
"pdf_url": "<string>",
"studio_link": "<string>"
},
"extract": [
{
"split_name": "<string>",
"page_range": [
123
],
"result": {
"usage": {
"num_pages": 123,
"num_fields": 123,
"credits": 123
},
"result": [
"<unknown>"
],
"citations": [
"<unknown>"
],
"response_type": "extract",
"job_id": "<string>",
"studio_link": "<string>",
"response_confidence": {}
},
"partition": "<string>"
}
],
"split": {
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
},
"result": {
"section_mapping": {},
"splits": [
{
"name": "<string>",
"pages": [
123
],
"conf": "low",
"partitions": [
{
"name": "<string>",
"pages": [
123
],
"conf": "low"
}
]
}
]
},
"response_type": "split"
},
"edit": {
"document_url": "<string>",
"response_type": "edit",
"form_schema": [
{
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"description": "<string>",
"fill": true,
"value": "<string>",
"font_size": 36.5
}
],
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
}
}
},
"response_type": "pipeline"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Document Processing
Pipeline
POST
/
pipeline
Pipeline
import requests
url = "https://platform.reducto.ai/pipeline"
payload = {
"document_url": "<string>",
"pipeline_id": "<string>",
"settings": {}
}
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({document_url: '<string>', pipeline_id: '<string>', settings: {}})
};
fetch('https://platform.reducto.ai/pipeline', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.reducto.ai/pipeline"
payload := strings.NewReader("{\n \"document_url\": \"<string>\",\n \"pipeline_id\": \"<string>\",\n \"settings\": {}\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))
}{
"job_id": "<string>",
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
},
"result": {
"parse": {
"job_id": "<string>",
"duration": 123,
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
},
"result": {
"type": "<string>",
"chunks": [
{
"content": "<string>",
"embed": "<string>",
"enriched": "<string>",
"blocks": [
{
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"content": "<string>",
"image_url": "<string>",
"chart_data": [
"<string>"
],
"confidence": "low",
"granular_confidence": {
"extract_confidence": 123,
"parse_confidence": 123
},
"merged_tables": [
{
"content": "<string>",
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"image_url": "<string>"
}
],
"extra": {}
}
],
"enrichment_success": false
}
],
"ocr": {
"words": [
{
"text": "<string>",
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"confidence": 123,
"chunk_index": 123,
"rotation": 123
}
],
"lines": [
{
"text": "<string>",
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"confidence": 123,
"chunk_index": 123,
"rotation": 123
}
]
},
"custom": null
},
"response_type": "parse",
"pdf_url": "<string>",
"studio_link": "<string>"
},
"extract": [
{
"split_name": "<string>",
"page_range": [
123
],
"result": {
"usage": {
"num_pages": 123,
"num_fields": 123,
"credits": 123
},
"result": [
"<unknown>"
],
"citations": [
"<unknown>"
],
"response_type": "extract",
"job_id": "<string>",
"studio_link": "<string>",
"response_confidence": {}
},
"partition": "<string>"
}
],
"split": {
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
},
"result": {
"section_mapping": {},
"splits": [
{
"name": "<string>",
"pages": [
123
],
"conf": "low",
"partitions": [
{
"name": "<string>",
"pages": [
123
],
"conf": "low"
}
]
}
]
},
"response_type": "split"
},
"edit": {
"document_url": "<string>",
"response_type": "edit",
"form_schema": [
{
"bbox": {
"left": 123,
"top": 123,
"width": 123,
"height": 123,
"page": 123,
"original_page": 123
},
"description": "<string>",
"fill": true,
"value": "<string>",
"font_size": 36.5
}
],
"usage": {
"num_pages": 123,
"credits": 123,
"credit_breakdown": {},
"page_billing_breakdown": {},
"non_empty_cell_count": 123
}
}
},
"response_type": "pipeline"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The URL of the document to be processed. You can provide one of the following: 1. A publicly available URL 2. A presigned S3 URL 3. A reducto:// prefixed URL obtained from the /upload endpoint after directly uploading a document 4. [API-131] A list of URLs (for multi-document pipelines, V3 API only)
The ID of the pipeline to use for the document.
Settings for pipeline execution that override pipeline defaults.
Show child attributes
Show child attributes
Was this page helpful?
⌘I