Skip to main content
GET
Requires version 1.1.0 or later of the Archetype platform.

Overview

This endpoint returns the configuration schema for a specific pipeline, including the user-facing JSON Schema, full config schema, and input/output port definitions. Use this to understand what parameters a pipeline accepts before creating a job.

Request

string
required
The unique pipeline identifier

Response

string
Pipeline identifier
string
Pipeline key
string
Pipeline version
object
User-facing JSON Schema describing the configurable parameters for this pipeline (pretty-printed JSON)
object
Full JSON Schema for the pipeline configuration
object
Input port definitions, each with name, description, mode (plain_file_list or n_shot_file_list), distribute (scatter or replicate), required (bool), and tracked (bool — false for reference/n-shot ports whose inputs land in the terminal reference status).
object
Output port definitions, each with name and description fields
Use the user_schema field to understand what parameters you can pass in the config field when creating a job. This schema describes the user-configurable options for each pipeline component.