Get handler definition by type
GET /handler-definitions/{handlerType}
Returns metadata about a specific pipeline handler type.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Responses
Section titled “ Responses ”Handler definition found
object
object
object
object
object
object
object
object
object
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
object
object
object
object
object
object
object
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
object
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
object
object
object
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
object
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
object
object
object
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
object
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
object
object
object
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
object
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
object
object
object
object
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