List assets
GET /assets
Returns a page of live assets, newest first. With
include_deleted=true, system.admin also gets soft-deleted assets
(the trash view); for anyone else the parameter changes nothing.
Anonymous visitors get only active, public, processed assets; signed-in accounts get every status and tier, with a placeholder for each one they can’t open, apart from the mature filter below.
Without a session or token you get 401 unless the instance lets
anonymous visitors browse. Mature-rated assets are left out unless
the instance allows mature content and you’ve opted in to see it,
you’re signed in and own them, or you have system.admin.
A page holds 50 assets unless you set limit (1 to 200; other
values are clamped). When there are more, next_cursor is set; pass
it back as cursor. A cursor that can’t be decoded gets 500, and a
parameter of the wrong type, such as limit=abc, gets a plain-text
400.
Filters narrow the page and combine with each other; none of them
gives access to anything. Items don’t include tag_details or
subtitle_tracks. In this list mature reads false on every
readable item (placeholders leave it out) and ai_provenance is
always absent; get the asset with GET /assets/{id} for those. For
structured queries, use /search.
Parameters
Section titled “ Parameters ”Query Parameters
Section titled “Query Parameters ”Only assets owned by this user ref.
Only assets this user ref has liked. Here, assets whose details you can’t read are left out instead of shown as placeholders, so the page doesn’t reveal that someone liked something you can’t see.
Only assets of this type ref.
Only assets with this status. Anonymous visitors only ever see active assets. A value not in the list matches nothing rather than being rejected.
Only assets with exactly this tag. Tags are case-sensitive.
Only assets assigned to this team. It’s a filter, not a grant: you get the same assets and placeholders as without it, minus other teams’. An unknown team gives an empty page, but a deleted team still matches its assets.
Plain-text search. Every word has to appear in the asset’s title,
description, searchable field values or file kind, such as image.
Tags aren’t searched; use tag for those. Assets whose details you
can’t read never match.
The next_cursor from the previous page.
Page size. Values outside 1 to 200 are moved to the nearest end of that range.
With true, system.admin also gets soft-deleted assets, with
deleted_at set. Anyone else gets the normal list.
Responses
Section titled “ Responses ”A page of assets
object
An asset: a record with a title, tags and other details, and
optionally a link to one stored file. Which fields appear depends on
the endpoint, so treat everything except id and restricted as
optional.
If its sensitivity tier keeps you from opening an asset, you get a
placeholder instead: restricted is true, and apart from id
only owner_display_name can appear, so you can show whose work it
is and offer to request access. GET /assets/{id} can also attach
subtitle_tracks to a placeholder. Someone who can manage an asset
without being able to open it gets its fields, but no thumbhash,
and its preview flags are false.
object
true when this is a placeholder for an asset you can’t open.
Always present, so check it before reading anything else.
On a placeholder only: the owner’s display name. Absent when there’s no name that can be shown, for example to an anonymous visitor when the owner hides their profile from them.
Anonymous visitors see only active assets. draft and archived don’t hide an asset from other signed-in accounts.
true when the work is rated mature. The rating is about who has
chosen to see mature work; it’s separate from the sensitivity tier,
which decides who is allowed to see it.
A viewer qualifies for mature work when the instance allows it and
they’ve opted in; signed-in owners and system.admin are let
through either way. For anyone else, the browse list leaves mature
assets out and their files are refused, but GET /assets/{id} still
returns the record, so use this flag to label what you show. GET /assets reports false on every readable item, and placeholders
leave it out.
The maker’s statement about generative AI in this work: none,
assisted or generated. Absent means nobody has said, which isn’t
the same as none; show it as “not stated” or show nothing. It’s a
label people can filter by, never a reason to hide the work. GET /assets leaves it out even when it’s set.
The SHA-256 of the linked file, as used by GET /storage/objects/{hash}. Absent when no file is linked.
The file’s size in bytes, when recorded. Assets created with POST /assets don’t record it.
The asset’s tags, as plain strings. tag_details has the same tags
with where each one came from.
The same tags with their source and, for AI tags, confidence and
model. Only GET /assets/{id} includes it, and only when the asset
has tags.
One tag and where it came from.
object
The tag.
manual for tags people added, ai for AI tagging, import for
imported tags. AI tagging replaces only earlier AI tags; replacing
the tag list with PATCH /assets/{id} removes all three kinds.
For AI tags, the provider’s confidence from 0 to 1. Absent for other tags.
For AI tags, the provider that suggested it, such as openai or ollama.
For AI tags, the model that suggested it.
Free-form JSON stored with the asset. Clients can keep their own keys here, and background processing adds its own sections. Updating it replaces the whole object.
object
The asset’s workflow state, if it has one.
The team the asset is assigned to. It’s set when the asset is created and can’t be changed. Absent when there is none, and on placeholders.
Where the asset’s preview processing stands, as recorded. pending
means the preview job hasn’t finished or never started: an asset
with no linked file, or whose job couldn’t be queued, stays
pending, and its variants can return 404. ready means the
preview job finished or none was needed; other background jobs, such
as transcription, may still be running. failed means the preview
job stopped with an error. While a job runs, the value can also be
processing, which isn’t in the list below. Anonymous visitors see
only ready assets.
Like the preview flags, this is a stored marker: it doesn’t check that the file or its renditions are actually in storage.
true when a col thumbnail is recorded for the file and you may
see the asset’s pictures. When it’s false, don’t request one.
This and the other preview hints (ladder_available,
scrub_available, thumbhash) come from the server’s records, not
from storage, so a request can still fail if a stored copy is
missing. “May see the pictures” follows the sensitivity tier; on
GET /assets/{id} it doesn’t take the mature rating into account,
so a viewer who doesn’t qualify for mature work can see true and
still have the request refused.
true when every size in the instance’s preview ladder (see GET /previews) is recorded and you may see the asset’s pictures, on the
same basis as preview_available. Check it before requesting the
larger sizes; preview_available covers only the col thumbnail.
true when a sprites.vtt hover-scrub file is recorded and you may
see the asset’s pictures, on the same basis as preview_available.
Whether an anonymous visitor would be shown this asset: it’s live,
active, public and processed. The answer is the same for
everyone, so it says nothing about what you can see. It doesn’t take
the mature rating or the instance’s anonymous-browsing setting into
account. Useful when choosing a cover for something public.
A small encoded blur of the image (a base64 thumbhash) to show while
it loads. Absent when there isn’t one or you may not see the asset’s
pictures, on the same basis as preview_available.
The width in pixels of the image the previews are made from, when it
has been recorded. For files without pixels, such as 3D models,
fonts or audio, it’s the size of the image their preview is drawn
from. Photos are measured after their EXIF rotation. pixel_width
and pixel_height always come together or not at all.
The height to go with pixel_width.
When the asset last changed, including changes made by background processing. Send it as if_unchanged_since when you update.
When the asset was deleted. Only soft-deleted assets in GET /assets?include_deleted=true results have it.
The reason given when it was deleted, if any. Appears with deleted_at.
Subtitle and caption tracks for the asset. Only GET /assets/{id}
includes them, and only when there are some.
One subtitle or caption track. An asset has at most one per language; uploading another for the same language replaces it.
object
The track’s language tag, such as en or fr-CA. und means the
language couldn’t be worked out from the file name.
A display name, such as English (US) or Forced. Empty when none
was given.
The SHA-256 of the stored WebVTT file.
The format the track was uploaded in. It’s stored as WebVTT whatever the source format.
How reliable the conversion to WebVTT is, from 0 to 1. Every format accepted today converts from text and gives 1; image-based subtitles, such as DVD IDX files, aren’t accepted yet.
Field values to show on a card, already formatted and in the order the operator set. Absent when there are none and on placeholders. Only fields without a read restriction can appear.
One field value to show on a card.
object
The field’s code.
The field’s name, for a caption.
The value as one line of text. Never empty: a field with no value is left out instead.
The federated instance this asset came from. Absent for local assets.
object
The owner’s name and avatar, for showing on a card. Absent when the owner can’t be shown, for example to an anonymous visitor when the owner hides their profile from them, and on placeholders.
object
The handle. Also the profile link target
(/users/by-username/{username}).
The name to show, never empty: the profile’s display name, then the
account’s full name, then the username, and as a last resort user
followed by the account number. For readers who aren’t signed in,
the account’s full name is skipped; the display name and username
are still used.
The avatar URL stored on the user’s profile, if there is one; left out when none is stored.
Pass this as cursor to get the next page. Absent on the last page.
Authentication required, missing, or invalid
object
Human-readable error summary
Example
the request could not be completedExample
{ "error": "authentication required: sign in and retry with a valid session or API token"}Unexpected server error
object
Human-readable error summary
Example
the request could not be completed