Cancel pipeline execution
POST /pipeline-executions/{executionId}/cancel
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Unique identifier of the execution to retrieve
Unique identifier of the execution to retrieve
Responses
Section titled “ Responses ”Pipeline execution cancelled successfully
object
Unique identifier for this execution
ID of the pipeline being executed
Name of the pipeline at time of execution
Handler type used for execution (e.g., python, sql)
Schema defining expected input parameters
object
File inputs/outputs
object
Unique identifier for this file slot
Human-readable label for the file (e.g., ‘Input Document’)
Optional description of what this file represents
Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)
Whether this file is required
Whether multiple files can be selected for this slot
How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks
Dataset inputs/outputs
object
Unique identifier for this dataset slot
Human-readable label for the dataset (e.g., ‘Training Data’)
Optional description of what this dataset represents
JSON Schema describing the expected dataset structure
Whether this dataset is required
Whether multiple datasets can be selected for this slot
Optional row-level filter applied to any dataset in this slot
object
Column name in the dataset table
object
Reference to an input value (e.g., ‘input.dataInputs.tenantId’)
Structured data inputs/outputs
object
Unique identifier for this data input slot
Human-readable label for the data input (e.g., ‘Parameters’)
Optional description of what this data input represents
JSON Schema describing the expected data structure
Whether this data input is required
Schema defining expected output structure
object
File inputs/outputs
object
Unique identifier for this file slot
Human-readable label for the file (e.g., ‘Input Document’)
Optional description of what this file represents
Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)
Whether this file is required
Whether multiple files can be selected for this slot
How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks
Dataset inputs/outputs
object
Unique identifier for this dataset slot
Human-readable label for the dataset (e.g., ‘Training Data’)
Optional description of what this dataset represents
JSON Schema describing the expected dataset structure
Whether this dataset is required
Whether multiple datasets can be selected for this slot
Optional row-level filter applied to any dataset in this slot
object
Column name in the dataset table
object
Reference to an input value (e.g., ‘input.dataInputs.tenantId’)
Structured data inputs/outputs
object
Unique identifier for this data input slot
Human-readable label for the data input (e.g., ‘Parameters’)
Optional description of what this data input represents
JSON Schema describing the expected data structure
Whether this data input is required
Pipeline configuration at time of execution
object
File configurations
object
Unique identifier for this file slot
Human-readable label for the file (e.g., ‘Input Document’)
Optional description of what this file represents
Accepted file types (MIME types or extensions, e.g., ‘.pdf,.docx’)
Whether this file is required
Whether multiple files can be selected for this slot
How file content is retrieved: ‘semantic’ uses vector similarity search, ‘full’ returns all chunks
Dataset configurations
object
Unique identifier for this dataset slot
Human-readable label for the dataset (e.g., ‘Training Data’)
Optional description of what this dataset represents
JSON Schema describing the expected dataset structure
Whether this dataset is required
Whether multiple datasets can be selected for this slot
Optional row-level filter applied to any dataset in this slot
object
Column name in the dataset table
object
Reference to an input value (e.g., ‘input.dataInputs.tenantId’)
Structured data configurations
object
Unique identifier for this data input slot
Human-readable label for the data input (e.g., ‘Parameters’)
Optional description of what this data input represents
JSON Schema describing the expected data structure
Whether this data input is required
object
Structured data value matching the schema
LLM handler configuration
object
LLM model in {provider}/{model} format (e.g., vertexai/gemini-3-flash-preview)
Generation temperature (0 = deterministic, 2 = creative)
Maximum output tokens
Web search configuration for automatic context retrieval
object
Enable automatic web search query generation and execution
Maximum number of queries to generate (1-5, default: 3)
Maximum results per query (1-20, default: 5)
Search depth: basic (1 credit) or advanced (2 credits, default: basic)
Include AI-generated answer summary from Tavily (default: false)
URL scraping configuration
object
Enable automatic URL detection and scraping (default: true)
Content type for scraped pages (default: ‘markdown’)
Enable JavaScript rendering (default: true)
Maximum planning/retrieval iterations. Each iteration plans what to retrieve, fetches context, and evaluates sufficiency before answering.
Current execution status (pending, running, succeeded, failed, cancelled)
Input parameters provided for this execution
Output data from the execution, or null if not yet complete
Citations mapping output fields to source documents
object
JSON Pointer (RFC 6901) to field in output, e.g., ‘/keyMetrics/revenue’
Starting character position of citation marker in output
Ending character position of citation marker in output
Citations supporting this output field
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
A unique nanoid for the resource (for more information please see: https://zelark.github.io/nano-id-cc/)
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Error message if execution failed
Execution progress percentage (0-100), or null if not trackable
Human-readable progress message
When execution actually started running
When execution completed (success or failure)
When the execution was queued
User ID who triggered this execution
Bad Request - Validation error or invalid input
object
Unauthorized - Authentication required or invalid token
object
Forbidden - Insufficient permissions
object
Not Found - Resource does not exist
object
Conflict - Resource already exists or operation conflicts with current state