Skip to Content
prxy.monster v1 is in early access. See what shipped →
APIGET /v1/pipeline

GET /v1/pipeline

Returns the pipeline that would run for a request authenticated with this key right now. Honors per-request override headers — useful for previewing what a custom pipeline would look like before you deploy it.

Endpoint

GET https://api.prxy.monster/v1/pipeline

Headers

HeaderRequiredNotes
Authorization: Bearer <key>yesYour prxy_live_xxx key.
x-prxy-pipenoPreview a custom pipeline (instantiates and reports — doesn’t actually call any provider).

Response

{ "configured": ["mcp-optimizer", "semantic-cache"], "active": [ { "name": "mcp-optimizer", "version": "1.0.0" }, { "name": "semantic-cache", "version": "1.0.0" } ], "override": null, "note": "Override per request via the x-prxy-pipe header." }
FieldMeaning
configuredModules from PRXY_PIPE env var (process-wide default, may be empty if using per-key config).
activeModules actually instantiated for this key, in execution order.
overrideThe x-prxy-pipe header value if present, else null.
noteHuman-readable hint.

Resolution priority

When the gateway computes active, it walks this priority list (highest wins):

  1. x-prxy-pipe header (if present) — preview/override.
  2. API key’s pipelineConfig field (set in dashboard or via PATCH /v1/keys/:id).
  3. PRXY_PIPE env var (process default).
  4. config.yaml (local mode).
  5. Built-in default: mcp-optimizer,semantic-cache,patterns.

In cloud mode, usage-tracker is appended to active automatically — you’ll always see it as the last entry.

Examples

# Show the resolved pipeline curl https://api.prxy.monster/v1/pipeline \ -H "Authorization: Bearer prxy_live_xxx" # Preview what a different pipeline would look like curl https://api.prxy.monster/v1/pipeline \ -H "Authorization: Bearer prxy_live_xxx" \ -H "x-prxy-pipe: exact-cache,semantic-cache,cost-guard,patterns"

Errors

Statuserror.typeWhen
401authentication_errorMissing / invalid key.
400invalid_requestOverride pipeline references unknown module.
Last updated on