POST
/
invoke
/
{pipeline_id}
from mixpeek import Mixpeek

# Initialize the Mixpeek client with your API key
mixpeek = Mixpeek('API_KEY')

# Example of invoking a pipeline using the Mixpeek Python SDK
response = client.invoke_pipeline(
    pipeline_id='mixed-bread',
    payload={
        'corpus': 'hello my name is bob'
    }
)

{
  "status": "<string>",
  "processed_data": "<any>",
  "error_details": {}
}

This endpoint allows users to actively run their data through configured pipelines, applying transformations and storing results as specified in the pipeline setup.

What is returned is then inserted (or updated) in your destination collection atomically.

Typically these get invoked automatically as objects are added from the source (like S3), but you can call /invoke for testing (or more custom) purposes.

​
Request

pipeline_id
string
required

The unique identifier of the pipeline to be invoked.

payload
json
required

The data payload that the pipeline will process. This must be structured in a way that the transformation code can effectively operate on it.

options
object

Any runtime options that affect how the pipeline processes the payload, such as parameters for rate limiting, concurrency, or other execution specifics.

​
Response

status
string
required

Indicates the result of the pipeline execution, such as “success”, “error”, or “processing”.

processed_data
json

The transformed data resulting from the pipeline execution, depending on the pipeline configuration and transformation applied.

error_details
object

Provides detailed information in case the pipeline encounters an error during execution. This may include error messages or codes.

from mixpeek import Mixpeek

# Initialize the Mixpeek client with your API key
mixpeek = Mixpeek('API_KEY')

# Example of invoking a pipeline using the Mixpeek Python SDK
response = client.invoke_pipeline(
    pipeline_id='mixed-bread',
    payload={
        'corpus': 'hello my name is bob'
    }
)

Was this page helpful?

Create PipelineUpdate Pipeline