Batches

Stream batch items (Phase 2)

Changed on

Phase 2 of 2-phase batch API. Accepts an NDJSON stream of batch items and enqueues them. Each line in the body should be a valid BatchItemNDJSON object. The stream is processed with backpressure - items are enqueued as they arrive. The batch is sealed when the stream completes successfully.

post/api/v3/batches/{batchId}/items

Request

  • Base URL: https://api.trigger.dev
  • URL: https://api.trigger.dev/api/v3/batches/{batchId}/items
  • Auth: HTTP bearer

Path parameters

batchIdstring required

The batch ID returned from POST /api/v3/batches

Response

Items successfully processed

idstring required

The batch ID.

itemsAcceptedinteger required

Number of items successfully accepted.

itemsDeduplicatedinteger required

Number of items that were deduplicated (already enqueued).

sealedboolean required

Whether the batch was sealed and is ready for processing. If false, the batch needs more items before processing can start. Clients should check this field and retry with missing items if needed.

enqueuedCountinteger

Total items currently enqueued. Only present when sealed=false to help with retries.

expectedCountinteger

Expected total item count. Only present when sealed=false to help with retries.

Changes

  • 0f61d649d288Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0e8378fc02a0Revision changes
    • info

      endpoint added