GET /generations — List and Filter Generation History

GET /generations returns a paginated list of all generation jobs on your account, including their current status, output URLs, and credit ledger entries. Use it to build dashboards, audit credit usage, or let users browse past results. GET https://v1.api.estudjo.com/generations

string

required

Your estudjo API key.

Query parameters

integer

Page number to retrieve. Defaults to 1.

integer

Number of results per page. Accepts 1–250. Defaults to 250.

string

Filter results to a single status. Accepted values: pending, completed, or failed. Omit to return all statuses.

Example request

curl 'https://v1.api.estudjo.com/generations?status=completed&limit=20&page=1' \
  -H 'X-Api-Key: YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "generations": [
      {
        "task_id": "bcfeabcb2195e728c29369dc29c9cc32",
        "status": "completed",
        "result_urls": [
          "https://storage.estudjo.com/generations/bcfeabcb2195e728c29369dc29c9cc32/5587d45a00b7b4dd2fb441c1edee7ac3.png"
        ],
        "credits_logs": [
          {
            "type": "reserve",
            "amount": "-4",
            "balance_after": "10992.5",
            "date_created": "2026-07-10T14:45:50.443061+03:00"
          },
          {
            "type": "spend",
            "amount": "0",
            "balance_after": "10992.5",
            "date_created": "2026-07-10T14:46:09.371124+03:00"
          }
        ],
        "date_created": "2026-07-10T14:45:50.443061+03:00"
      }
    ],
    "page": 1,
    "per_page": 20,
    "total": 37
  }
}

boolean

true when the request was valid and the response contains data.

object

Show data

array

Ordered list of generation objects for the requested page.

Show Generation object

string

Unique identifier for the generation job.

string

Current state: pending, completed, or failed.

string[]

Array of output file URLs. Present only when status is "completed".

string

Human-readable failure description. Present only when status is "failed".

array

Ordered list of credit ledger entries for this generation.

Show Credits log entry

string

Ledger entry type. See the credit log types table below for a full explanation.

string

Credit delta for this entry (e.g. "-4" or "0").

string

Your account balance immediately after this entry was applied.

string

ISO 8601 timestamp of when this ledger entry was recorded.

string

ISO 8601 timestamp of when the generation job was created.

integer

The current page number returned.

integer

The number of results per page actually used. This reflects the limit value that was applied — use ceil(total / per_page) to calculate the total number of pages.

integer

Total number of generations matching the query (across all pages).

Credit log types

Each generation produces one or more credits_logs entries that trace the full lifecycle of its credit charge.

Type	Meaning
`reserve`	Credits held against your balance when the job was queued
`spend`	Charge confirmed — credits were consumed after a successful generation
`release`	Credits refunded — the reserved amount was returned to your balance

Reading the ledger:

A single reserve entry with no follow-up → the generation is still pending.
reserve + spend → generation completed and credits were charged.
reserve + release → generation failed and the reserved credits were refunded.

per_page reflects the limit that was actually applied to the query (not necessarily what you passed). Always use ceil(total / per_page) to compute the total number of pages rather than ceil(total / limit).

Errors

Code	HTTP	Cause
`invalid_input`	400	`page` is not a positive integer, `limit` is outside `1`–`250`, or `status` is not one of `pending`, `completed`, or `failed`

Health

API Keys

Wallet

Generations

Scenes

GET /generations — List and Filter Generation History

Query parameters

Example request

Response

Credit log types

Errors

​Query parameters

​Example request

​Response

​Credit log types

​Errors

Query parameters

Example request

Response

Credit log types

Errors