Skip to main content
GET
List images
This is a legacy endpoint for existing integrations. New integrations should use the public v1 API. Use this endpoint to browse your image library or look for a request whose submission response was lost. Review the returned records before submitting again; see error recovery.

Authorizations

Authorization
string
header
required

Create an API key in Studio → account menu → API Keys. Keep it on your server.

Query Parameters

limit
integer

Page size.

Required range: 1 <= x <= 100
cursor
string<date-time>

Cursor returned by the previous page.

is_generated
boolean

Filter generated results versus uploads.

include_versions
boolean

Include related image versions.

task
string

Filter by operation, for example generate or edit.

favorite
boolean

Filter favorites.

Response

List images in the key’s workspace. Pass next_cursor unchanged to retrieve the next page.

images
object[]
required
next_cursor
string<date-time> | null
required

Pass unchanged as cursor on the next request.

total
integer | null

Present for queries that calculate a total.