Skip to main content
GET
List asset reference images
Work with reusable assets.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Image or asset ID from a previous response. Resource ID.

Query Parameters

for_training
enum<boolean>

Return source reference images. Send true to filter; omit to leave unfiltered. Any non-empty value currently enables the filter.

Available options:
true
is_generated
enum<boolean>

Filter generated images. Send true to filter; omit to leave unfiltered. Any non-empty value currently enables the filter.

Available options:
true

Response

Read images linked to the asset. Set for_training=true to retrieve reusable source references.

id
string<uuid>
required

Resource ID.

status
enum<string>
required

Job state. Only completed has a finished result.

Available options:
pending,
generating,
completed,
failed,
policy_blocked,
nsfw_filtered
path
string | null

Result URL. Can be null while the job is pending.

watermarked_path
string | null
width_px
integer | null
height_px
integer | null
size_bytes
integer | null
extension
string | null
is_generated
boolean
for_training
boolean

Whether the upload is a reusable asset reference.

task
string | null

Operation that created this job.

type
string | null
created_timestamp
string<date-time>
finish_timestamp
string<date-time> | null
fail_reason
string | null

Human-readable failure detail.

failure_code
enum<string> | null

Machine-readable failure category, when available.

Available options:
input_rejected,
provider_unavailable,
queue_timeout,
policy_blocked
asset_ids
string<uuid>[] | null

Linked reusable assets.

Resource ID.

versions
object[]

Related versions. May be omitted or empty. Never infer a new version is completed from the parent status.