Actions4
- Batch Actions
Batch → Get Results
AI-generatedSummary
Retrieve and paginate result items from a specific Batchly batch by its batch ID, with options to filter by result status, control pagination (return all or by pages), and format image outputs as JSON or binary data.
Inputs
- Batch ID (required) — The Batchly batch_id string identifying which batch's results to retrieve.
- Status Filter — Filter the results by status: 'all', 'completed', or 'failed'. Defaults to 'all'.
- Return All — Boolean flag to fetch all available results pages (true) or limit to one page (false). Defaults to true.
- Page Size — Number of result items to fetch per API request page, between 1 and 500. Defaults to 100.
- Image Output — Choose whether image data in results remains as JSON only or also is exposed as n8n binary fields. Defaults to 'json'.
- Image MIME Type — When Image Output is set to 'binary', select the MIME type of the image data: PNG, JPEG, or WebP. Defaults to PNG.
- Cursor — Optional pagination cursor string from a previous paged results response to continue fetching the next page.
Output shape
a list of result items, each including batch ID, custom ID, status, output content, error info, usage data, creation timestamp, and additional batch metadata; optionally includes binary image data fields if enabled.
Supports pagination controlled by 'Return All' and 'Page Size'. If 'Return All' is false, 'Cursor' can be used to specify the next page to retrieve. Throws error if more than 1000 pages are fetched to prevent excessive loops.
Examples
Example 1: Retrieve all results for a given batch and receive images as JSON only
Batch ID provided, Status Filter set to 'all', Return All true, Image Output 'json'.
Example 2: Fetch only completed results for a batch, fetching a single page of 50 items with images as binary data in PNG format
Batch ID provided, Status Filter set to 'completed', Return All false, Page Size 50, Image Output 'binary', Image MIME Type 'image/png', Cursor optionally set to next_cursor from a previous run.