Skip to main content

​
pipeline.run()

Executes a custom pipeline synchronously on a document. 
client.pipeline.run(
    input="https://example.com/document.pdf",
    pipeline_id="your-pipeline-id",
    settings={...}
)

​
Parameters

​
input
string | list[string]
required
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
object
Settings for pipeline execution that override pipeline defaults.

​
Response

​
PipelineResponse
object
Returns the result of the pipeline execution.
​
result
object
The processed document data according to the pipeline configuration.

​
pipeline.run_job()

Executes a custom pipeline asynchronously and returns a job ID immediately. 
response = client.pipeline.run_job(
    input="https://example.com/document.pdf",
    pipeline_id="your-pipeline-id",
    async_={"webhook": {"url": "https://example.com/webhook"}},
    settings={...}
)

print(response.job_id)  # Use this to check job status later

​
Parameters

​
input
string | list[string]
required
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.
​
async_
ConfigV3AsyncConfig
The configuration options for asynchronous processing (default synchronous).
​
settings
object
Settings for pipeline execution that override pipeline defaults.

​
Response

​
PipelineRunJobResponse
object
​
job_id
string
The ID of the asynchronous job. Use client.job.get(job_id) to retrieve the result when the job completes.