Skip to main content
GET
Get an outfit

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Path Parameters

handle
string
required

The outfit's handle, with or without the @ (camel_belted_overcoat_outfit), or the id of one of your own outfits.

Response

The outfit.

An outfit a character can wear, called by writing its mention next to the character in a prompt.

category
string
Example:

"outerwear"

colors
string[]
Example:
costume_character
string

On a famous character's outfit (anime, game, film), the character. Absent otherwise. It is in the tags too, so q finds it.

Example:

"Ada Wong"

costume_franchise
string

On a famous character's outfit, where the character is from. Absent otherwise.

Example:

"Resident Evil"

description
string

What the outfit is, word for word as it is added to the prompt with the mention.

Example:

"Camel mid-length wool blend overcoat with waist belt, black turtleneck, black tailored trousers, black leather dress shoes."

handle
string
Example:

"camel_belted_overcoat_outfit"

id
string<uuid>
kind
string
Example:

"outfit"

mention
string

Write this next to a character in an image or video prompt.

Example:

"@camel_belted_overcoat_outfit"

name
string
Example:

"Camel Belted Overcoat Outfit"

preview_url
string<uri>

The picture at most 800 px on its long side, for a preview (a signed link that expires after a few hours).

source
enum<string>

mine = made by you; saved = kept from the free library or from another member; house = the free library.

Available options:
mine,
saved,
house
tags
string[]
Example:
thumbnail_url
string<uri>

The picture at most 350 px on its long side, for a list or a grid (a signed link that expires after a few hours).

error
string
how_to_use
string
picture_url
string<uri>

The full-size picture a mention sends: 896x1200 for an outfit made from a photo or a description, a clean picture at its own size (a signed link that expires after a few hours).

status
enum<string>

On an outfit you are adding: processing while its picture is made (its handle is final once ready), or failed with error.

Available options:
processing,
ready,
failed