Skip to main content
GET
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

pipelineId
string
required

Pipeline ID with prefix pl..

Pattern: ^pl\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Response

Live pipeline graph snapshot

A live pipeline graph and the version required for conflict-safe replacement.

graph
object
required

Current pipeline configuration, including fields, nodes, connections, and optional layout.

invalidFieldSchemas
object[]
required

Fields whose stored JSON Schema cannot be read, for example after an unfinished edit in the UI. Each one appears in graph.fields with a placeholder schema that only carries a description; replace the graph with a valid schema for the field to repair it.

Maximum array length: 500
version
string
required

The snapshot version expected to still be active. A stale version is rejected with HTTP 409.

Pattern: ^ple\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$