Skip to content

Get Pipeline

GET
/api/v1/pipelines/{route_id}

Get pipeline detail. Searches across all active executions.

route_id
required
Route Id
string

Successful Response

PipelineDetail

Detailed pipeline information.

object
route_id
required
Route Id

Unique route identifier

string
name
required
Name

Pipeline name

string
running
required
Running

Whether pipeline is currently running

boolean
execution_id
Any of:
string
inbound_config
required
Inbound Config

Inbound queue configuration

object
key
additional properties
any
adapters
required
Adapters

Configured adapters

Array<object>
AdapterInfo

Adapter information.

object
name
required
Name

Adapter name

string
type
required
Type

Adapter type

string
config
required
Config

Adapter configuration

object
key
additional properties
any
storage_destinations
Storage Destinations

Storage destinations for adapters with ‘stage’ config

Array<object>
StorageDestination

Storage destination information for an adapter.

object
adapter
required
Adapter

Adapter name/type that writes to storage

string
stage
required
Stage

Storage stage/path (e.g., ‘boost/filtered/’, ‘markdown_converted’)

string
metrics
required
Metrics

Pipeline metrics

object
key
additional properties
integer
backpressure
Any of:
BackpressureMetrics

Backpressure controller metrics.

object
current_rate
required
Current Rate

Current processing rate (msgs/sec)

number
target_rate
required
Target Rate

Target rate from config (msgs/sec)

number
in_flight
required
In Flight

Current in-flight message count

integer
max_in_flight
required
Max In Flight

Maximum allowed in-flight messages

integer

Resource not found

ErrorResponse

Standard error response matching FastAPI HTTPException format.

This model is used in OpenAPI response declarations for 4xx/5xx errors. The detail field matches FastAPI’s HTTPException structure.

object
detail
required
Detail

Error message (matches FastAPI HTTPException)

string
error_code
Any of:
string
correlation_id
Any of:
string
timestamp
Timestamp

Error timestamp

string format: date-time

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object