Batches

Retrieve a batch

A batch with every generation in it, each as GET /v1/generations/{id} would return it. Send Prefer: wait=60 to hold the read until every run is final or 60 seconds pass. While any run isn't final, Retry-After says how many seconds to wait before the next read.

Needs an API key with the generations:read scope.

get/v1/batches/{id}

Request

  • Base URL: https://api.tryleap.ai
  • URL: https://api.tryleap.ai/v1/batches/{id}
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Path parameters

idstring required

The batch's ID, bat_....

Headers

Preferstring

wait=N holds the request open for up to N seconds (at most 60) until the generation finishes, and Preference-Applied echoes the wait used. Most images finish inside the wait. If the run is still going when it ends, you get it back queued or running; poll it from there. Without this header the generation comes back queued at once.

Example:wait=60

Response

The batch, as it is now or when the wait ends.

idstring required

The batch's ID, bat_....

object'batch' required

Changes

No recorded changes to this operation across all 1 revision of this API.