Pipeline

POST /pipeline

Pipeline

Python

import requests

url = "https://platform.reducto.ai/pipeline"

payload = {
    "input": "<string>",
    "pipeline_id": "<string>",
    "settings": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

200

{
  "job_id": "<string>",
  "usage": {
    "num_pages": 123,
    "credits": 123,
    "credit_breakdown": {},
    "page_billing_breakdown": {}
  },
  "result": {
    "parse": {
      "job_id": "<string>",
      "duration": 123,
      "usage": {
        "num_pages": 123,
        "credits": 123,
        "credit_breakdown": {},
        "page_billing_breakdown": {}
      },
      "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
                },
                "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": {},
        "partition": "<string>"
      }
    ],
    "split": {
      "usage": {
        "num_pages": 123,
        "credits": 123,
        "credit_breakdown": {},
        "page_billing_breakdown": {}
      },
      "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": {}
      }
    }
  },
  "response_type": "pipeline"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

user-id · string | null

Body

application/json

input · string string[] UploadResponse · object · required

For parse/split/extract pipelines, 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. A jobid:// prefixed URL obtained from a previous /parse invocation 5. A list of URLs (for multi-document pipelines, V3 API only)

For edit pipelines, this should be a string containing the edit instructions

pipeline_id · string · required

The ID of the pipeline to use for the document.

settings · PipelineSettings · object

Settings for pipeline execution that override pipeline defaults.

Show child attributes

Response

200

application/json

Successful Response

job_id · string · required

usage · ParseUsage · object · required

Show child attributes

result · PipelineResult · object · required

Show child attributes

response_type · string · default: pipeline

Allowed value: "pipeline"