Developers · Preview documentation

The Nextra Flow API.

Run flows, read runs and manage connections over HTTPS and JSON. Preview documentation; endpoint shapes are illustrative.

API reference / Run a flow

API reference

Run a flow

POST/v1/flows/run

Queue a run of a flow with a batch of records.

Runs are asynchronous. The response returns a run you can poll or receive by webhook.

flowstring · requiredThe flow ID or slug to run.
recordsarray · requiredUp to 1,000 source records per request.
idempotency_keystring · optionalMakes retries safe. Reusing a key returns the original run.
modestring · optionalasync (default) or sync for small batches.
curlIllustrative
curl -X POST https://api.nextranslate.example/v1/flows/run \
  -H "Authorization: Bearer $NEXTRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "flow": "shopify_orders_to_erp",
    "records": [{ "customer_name": "Ananya Rao", "phone": "+91 98765 43210" }],
    "idempotency_key": "ord_10482"
  }'

Response

202 AcceptedIllustrative
{
  "run_id": "run_8f3k2",
  "status": "queued",
  "records": 1,
  "idempotency_key": "ord_10482"
}