Skip to main content

Documentation Index

Fetch the complete documentation index at: https://pixa.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Pipelines are saved multi-step workflows built from nodes — remove background, upscale, generate, and more — chained together in a graph. Create pipelines in the Pixa web app, then run them from any MCP-compatible agent.

Running a pipeline

Use the pipelines tool with action run:
Run my "Product Photo Cleanup" pipeline on these three product images.
The agent calls pipelines (action: get) to inspect the pipeline, then pipelines (action: run) with inputs mapped to the correct node IDs. Inputs are mapped by node alias. Values can be public URLs, Pixa asset IDs, or text — the agent picks the right type based on the node’s input spec.

MCP actions

The pipelines tool supports these actions:
ActionDescription
listList all pipelines
searchFind pipelines by name
getGet pipeline details with nodes and edges
runStart a pipeline execution
list_runsList runs for a specific pipeline
get_runGet run details with per-node status
cancel_runStop a running execution
list_node_typesAvailable node types with I/O specs
Use display_pipeline to render an interactive node graph preview in MCP App UIs.

Finding pipelines

What pipelines do I have for product photos?
The agent calls pipelines (action: search) with the relevant query, or list to browse everything available.

Monitoring runs

Pipeline runs are async. The pipelines (action: run) call returns a run_id. Track progress with:
Check the status of my pipeline run.
The agent calls pipelines (action: get_run) to fetch the run state, including per-node status and outputs.

End-to-end example

Run my "Product Cleanup" pipeline on this product photo and save the results to my Q3 Hero Shots collection.
The agent:
  1. Calls pipelines (search) to find the “Product Cleanup” pipeline.
  2. Calls pipelines (get) to inspect the input nodes.
  3. Calls pipelines (run) with the photo mapped to the right input and collection_id set to the target collection.
  4. Polls pipelines (get_run) until the run completes, then surfaces the resulting assets.
For more on pipeline concepts and the web-based pipeline editor, see the Pipelines user guide.