Skip to main content

Get Rail

Read a Spec composed pipeline rail: the ordered stages (source, registry, extraction, resolution, validation, assembly, delivery) plus their per-stage config.

The rail is the ordered list of pipeline stages composed onto a Spec (a user_schema). It is what POST /v1/pipelines compiles and runs, so it is the prerequisite for running a Spec from the API without the UI. This endpoint returns the rail as it is stored. It reads back as an empty array until a rail has been set.

Each stage carries a type plus optional name, sub, and a per-stage json config. The compiler maps registry to transfer, schema to extraction, resolve to resolution (one phase per active policy), valid to a positional validation checkpoint, and assembly to a post-run compose. The source, deliver, reconcile, sanitize, and triage types are composition markers in the rail order.

GET/v1/schemas/{id}/rail

Response

Returns { "rail": [...] }, where each element is a stage object. The array reflects the stored composition order. An empty array means no rail has been set yet, in which case the Spec cannot be run until you set one.

Response fields

railarrayOrdered array of stage objects.
rail[].typestringStage kind: source, registry, schema, resolve, valid, assembly, deliver, reconcile, sanitize, triage.
rail[].namestring | undefinedOptional display name for the stage.
rail[].substring | undefinedOptional sub-label for the stage.
rail[].jsonobject | undefinedPer-stage config (e.g. resolve policy_ids, valid stage_ids/target_phases, assembly grouping_field/anchor_field).

Response

{
  "rail": [
    { "type": "schema", "name": "Extraction" },
    {
      "type": "resolve",
      "name": "Resolution",
      "json": { "policy_ids": ["b2c3d4e5-f6a7-8901-bcde-f23456789012"] }
    },
    {
      "type": "valid",
      "name": "Totals checkpoint",
      "json": {
        "stage_ids": ["f1e2d3c4-b5a6-7890-abcd-ef1234567890"],
        "target_phases": ["resolve"]
      }
    }
  ]
}

Errors

Error responses

401unauthorizedMissing or invalid API key.
404not_foundNo Spec (schema) with this ID exists for your organization.
429rate_limitedToo many requests. Retry after the period indicated in the Retry-After header.

Related

Set Rail
Validation Stages
List Schemas