POST
/
pipelines
/
{pipeline_id}
curl --location 'https://api.mixpeek.com/pipelines/c7e006' \
--header 'Authorization: Bearer API_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "data": {
        "file_url": "https://example.com/document.pdf"
    },
    "settings": {
        "extraction_mode": "full_text"
    }
}'
{
  "task_id": "<string>",
  "status": "<string>"
}

Request

pipeline_id
string
required

The unique identifier of the pipeline you wish to invoke. This ID specifies which pipeline to trigger and is essential for routing the request correctly within the Mixpeek platform.

data
object

The data to be processed by the pipeline. This object can include any relevant information that the pipeline is configured to handle, such as URLs to documents for extraction or text content for embedding.

settings
object

Additional settings or parameters that affect how the pipeline processes the provided data. These settings can include configurations like processing modes, output formats, or any custom options supported by the pipeline.

Response

task_id
string
required

A unique identifier for the task created by invoking the pipeline. This ID can be used to track the status of the task, retrieve results, and manage subsequent processing steps.

status
string
required

Provides immediate feedback on the invocation status, indicating whether the pipeline execution has started successfully or if there were any issues triggering the process.