Skip to main content
POST
Promote an upload, or ingest from a URL

Authorizations

Authorization
string
header
required

An API key: ab_...

Body

application/json
token
string<uuid>
required

From POST /api/v1/uploads, after the PUT

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)$
filename
string
required
Required string length: 1 - 512
mime
string
required
Required string length: 1 - 255
fields
object

Custom field values, keyed by field key

collections
string<uuid>[]
Maximum array length: 50
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)$
tags
string[]
Maximum array length: 100
Maximum string length: 64
rights
object | null

What it may be used for; null or {} says nothing

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
versionOf
string<uuid>

A new version of this asset: it joins its version stack, collections, tags and fields, and with write on it becomes current

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)$
status
enum<string>

draft keeps it out of the library until it is submitted and approved. Without write it is proposed whatever this says

Available options:
draft,
active

Response

Deduped to an existing asset

data
object
required
deduped
boolean
required