Skip to main content
PATCH
Edit an asset, or review what was proposed

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

id
string
required

Asset id

Body

application/json
tags
string[]

Replaces the whole set

Maximum array length: 100
Maximum string length: 64
fields
object

Merges; null clears one unless it is required

title
string | null
Maximum string length: 2000
description
string | null
Maximum string length: 2000
creator
string | null
Maximum string length: 2000
Maximum string length: 2000
status
enum<string>

"proposed" submits a draft for review; "active" approves it; "rejected" turns it down and keeps it, with reviewNote; "archived" retires it, and /a/{id} answers 410. Anything but submitting or reworking a draft takes approve

Available options:
draft,
proposed,
active,
archived,
rejected
reviewNote
string | null

Why it was rejected, for whoever proposed it

Maximum string length: 2000
proposedTags
string[]

Replaces the pending suggestions; [] dismisses them all

Maximum array length: 100
Maximum string length: 64
rights
object | null

Replaces them whole; null clears

origin
enum<string> | null

Defaults to what its Content Credentials say, if any

Available options:
shot,
licensed,
generated
parentAssetId
string<uuid> | null

The asset it was made from: the photo an edit started from, a model's input

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
generator
string | null

The tool or model that made it, e.g. "gpt-image 2.0"

Maximum string length: 200
prompt
string | null

For a generated asset: what it was asked for

Maximum string length: 10000
supersededBy
string<uuid> | null

The asset that replaces this one; /api/v1/check then refuses it and names that

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
private
boolean

Only people with a grant on it, or on a collection it is in, and admins see it

Response

The updated asset

data
object
required