ZAPINNER

Workflows API

Chain deterministic capabilities (normalize, transform, validate, dedupe, anomalies) into one ordered, synchronous pipeline. Limited preview: availability is controlled by a feature flag.

This capability is in limited preview and is gated by a feature flag — calls return a clear “not enabled” error until it is turned on for your account.

What it does

Run an ordered pipeline of capabilities over one record set.

When to use it

Reach for Workflows when you need to answer: “Can I chain capabilities into one call?” It sits in the Orchestrate stage of the catalog — run several operations at once.

Endpoint & cost

POST /api/v1/workflows/run

Cost: Variable. 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/workflows/run \
  -H "Authorization: Bearer zap_live_••••••" \
  -H "Content-Type: application/json" \
  -d '{"data":{"records":[{"company":" ACME, INC. "}]},"steps":[{"capability":"normalize"},{"capability":"dedupe"}]}'
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

Workflows 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 Workflows in the playground to see the request, or run it live with your API key.

Related APIs

  • Analyze — Run several intelligence operations against one payload in a single call.
  • Execute — Route a plain-language instruction to the right capability and run it.
  • Pipeline — Chain record-in/record-out capabilities into one ordered call.