Skip to content

Listing

GET
/api/listing
curl --request GET \
--url 'https://example.com/api/listing?offset=0&limit=60&type=&q=&character_id=&tag=&training_dataset=&owner=&sort=' \
--header 'Authorization: Bearer <token>'

List generated media from the media table.

This is the source-of-truth catalog for all images and videos managed by FlixML Studio. Filters are applied in the database and support pagination, type filtering, free-text search, character/tag scoping, training dataset selection, and the account that submitted the job.

A scoped key sees what it made, plus anything bound to a character its account owns: a picture of a character is that character’s, whoever made it. owner narrows the result to one account’s files; it never widens what a key sees.

Returns 60 items from offset unless limit says otherwise; total is how many match in all.

Pass ?view=summary to get only what telling items apart needs — filename, type, workflow, description, tags, prompt, submitted_at, match — at about a quarter of the size. Without it each item carries everything the gallery shows.

match is how closely the face in an image of one character matches the rest of that character’s gallery: score is cosine similarity (higher is closer) and face_px the width of the face it read; faces under 150 px score less reliably. It is null for videos, images with no single character or no face, and on installs without the optional face packages. Pass ?sort=match for the closest matches first, or ?sort=match_asc for the furthest first; unscored files come last either way.

offset
Offset
integer
0
limit
Limit
integer
default: 60
type
Type
string
""
q
Q
string
""
character_id
Character Id
string
""
tag
Tag
string
""
training_dataset
Training Dataset
string
""
owner
Owner
string
""
view
Any of:
string
sort
Sort
string
""

Successful Response

Media typeapplication/json
Response Listing Api Listing Get
object
key
additional properties
any
Examplegenerated
{}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}