Skip to main content
PATCH
Update asset

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Path Parameters

asset_id
string
required

asset_id parameter

Body

application/json
name
string
purpose
string
assetType
enum<string>
Available options:
image,
logo,
icon

Response

Asset created successfully

assetId
string
required
tenantId
string
required
name
string
required
purpose
string
required
tags
string[]
required
aiDescription
string | null
required
textDensity
enum<string> | null
required
Available options:
none,
light,
heavy
thumbnailSuitability
integer | null
required
Required range: 1 <= x <= 5
centerCropSafe
boolean | null
required
parentAssetId
string | null
required
hidden
boolean
required
source
enum<string>
required
Available options:
uploaded,
generated
derivedFromAssetId
string | null
required
generator
string | null
required
generationSpec
string | null
required
paletteGeneration
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
data
object
required
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
updatedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
trashedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
deletedAt
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
lifecycleState
enum<string>
required
Available options:
active,
trashed,
deleted
downloadUrl
string | null
required
previewDownloadUrl
string | null
required