Skip to main content
GET
What an asset is and may be used for

Authorizations

Authorization
string
header
required

An API key: ab_...

Path Parameters

id
string
required

Asset id

Response

The description

id
string<uuid>
required
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
mime
string
required
size
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
width
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
height
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
sha256
string
required
status
enum<string>
required
Available options:
draft,
proposed,
active,
archived,
rejected
state
enum<string>
required

Only active is served at /a/{id} to anyone; expired and archived answer 410

Available options:
draft,
proposed,
active,
expired,
archived,
rejected,
deleted
version
integer | null
required

Its number in its stack of versions; null when it has one

Required range: -9007199254740991 <= x <= 9007199254740991
current
boolean
required

The version to use: its stack's current one, or the only one

proposedBy
string | null
required
reviewNote
string | null
required
title
string | null
required
description
string | null
required
creator
string | null
required
tags
string[]
required
fields
object
required

Effective values: own over inherited

collections
string<uuid>[]
required
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)$
rights
object | null
required
provenance
object
required
supersededBy
string<uuid> | null
required

Replaced: use this one instead

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)$
urls
object
required
constraints
object | null
required

What a rendition of this asset may ask for; null when it can't be transformed

alternatives
object[]
required

Ready-made renditions