Pipeline API

Runs an ordered chain of record-in / record-out capabilities (standardize, transform, redact, mask, normalize) over one record set, feeding each step's output into the next. The whole pipeline is validated before any step runs, and steps call each capability's pure engine directly. Deterministic; billed records × steps.

What it does

Chain record-in/record-out capabilities into one ordered call.

When to use it

Reach for Pipeline when you need to answer: Can I chain clean-up steps into one call? It sits in the Orchestrate stage of the catalog — run several operations at once.

Endpoint & cost

POST /api/v1/pipeline

Cost: Per credit. Zaps draw down your shared monthly allowance; requests that fail validation are not charged.

Authentication

Send your key as a bearer token: Authorization: Bearer zap_live_…. See Authentication for key management and the alternate header.

Example request

curl https://zapinner.com/api/v1/pipeline \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"data":{"records":[{"company":" ACME, INC. ","note":"call me at 704-555-1234"}]},"steps":[{"operation":"standardize"},{"operation":"redact"}]}'
Every response is structured JSON and includes a request_id. Full field-level request and response schemas for this endpoint live in the OpenAPI spec and the API reference.

Errors & limits

Errors use one consistent shape ( error.code, error.message, request_id). See Errors and Rate limits.

SDK

Pipeline has typed methods in both the JavaScript and Python SDKs. Both are implemented and package-ready but not yet published to npm / PyPI — until they ship, vendor the package source or install from a git ref, or call the endpoint over HTTPS with the example above.

Try it

Select Pipeline in the playground to see the request, or run it live with your API key.

  • Analyze Run several intelligence operations against one payload in a single call.
  • Workflows Run an ordered pipeline of capabilities over one record set.
  • Execute Route a plain-language instruction to the right capability and run it.