Skip to main content
POST
Trigger a definition

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string | null

Optional. Bulk (record_set_id) triggers only. Supply your own key to deliberately re-run content that was already submitted within the dedup window; omit it to let the server derive the key from the record set's content hash. Ignored on the inline records path.

Maximum string length: 255

Path Parameters

definition_id
string
required

Body

application/json
source
string
default:api
metadata
Metadata · object
input_data
Input Data · object
records
Records · object[]
scheduled_at
string<date-time> | null
scheduled_start_at
string<date-time> | null
variable_overrides
Variable Overrides · object
record_set_id
string | null

Id of a sealed record set to trigger against. Mutually exclusive with records. Use this for uploads above the inline record limit.

priority
enum<string> | null

Move this batch's work ahead of the rest of its own dispatch lane. high only re-orders work inside your own account's provider budget — it cannot take capacity from another lane, and it never changes how fast the provider accepts calls. Omit it to inherit the flow's own setting.

Available options:
normal,
high
pacing
BatchPacingPolicyIn · object | null

Release this batch's records no faster than N every M minutes, optionally confined to a local delivery window. Overrides any pacing policy the flow itself declares; omit it to inherit that policy, and omit both to deliver as fast as your provider budget allows.

Example:

Response

Batch started. deduplicated is true when this request matched a recent identical bulk submission — in that case batch_id echoes the ORIGINAL batch, its current status is returned, and nothing new was ingested.

batch_id
string
required
definition_id
string
required
status
string
required
deduplicated
boolean
default:false

True when this request matched a recent identical bulk submission — batch_id echoes the original batch and nothing new was ingested.

estimate
DispatchCostEstimate · object | null

What this trigger's work will cost against your provider budget — present only when the flow dispatches through a rate-limited platform budget, and null otherwise. A spills_past_day_cap warning is informational: the work was accepted and its overflow is paced into the following day, not refused.

Example: