The compiled, typed launch-parameter schema for one selected pipeline (ADR-0043 §4) — the on-selection describe. Resolves `ref` to a concrete commit (echoed back), reads the named pipeline there, and **fully compiles** it (reusing the shared [`prefetch_libs_and_compile`] — this is where the lib-prefetch cost is justified), returning `interface.inputs` as typed [`ParamSpec`](scarab_pipeline::ParamSpec)s. The response is a pure function of the compiled IR — the same path dispatch rides, no parallel parser — so a compile error surfaces as a structured 4xx (never a 500), identical to dispatch. Read capability.
const url = 'https://example.com/v1/repos/example/example/pipelines/example/interface';const options = {method: 'GET'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/v1/repos/example/example/pipelines/example/interfaceParameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Repo owner
Repo name
Pipeline name (bare, e.g. deploy)
Query Parameters
Section titled “Query Parameters”Ref to read the config at (default HEAD)
Responses
Section titled “Responses”The compiled typed parameter schema
GET /v1/repos/{org}/{repo}/pipelines/{name}/interface?ref= body: the
compiled, typed launch-parameter schema for ONE selected pipeline (ADR-0043
§4). A pure function of the compiled IR — the same compile path dispatch
rides — so the form and the run validate against byte-identical specs.
object
This pipeline opts into api dispatch (on: api).
The declared typed launch parameters (name, type, required, default,
options, validate, description) — the compiled interface.inputs.
object
This pipeline opts into manual dispatch (on: manual).
The ref resolved to a concrete commit — the interface reflects this exact commit; a subsequent dispatch should pin to it.
Examplegenerated
{ "api": true, "inputs": [ {} ], "manual": true, "sha": "example"}The pipeline failed to compile (structured diagnostic)
No pipeline by that name at the ref