curl --request GET \
--url https://api.budgetpixel.com/v1/wardrobe/{handle} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.budgetpixel.com/v1/wardrobe/{handle}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.budgetpixel.com/v1/wardrobe/{handle}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.budgetpixel.com/v1/wardrobe/{handle}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.budgetpixel.com/v1/wardrobe/{handle}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.budgetpixel.com/v1/wardrobe/{handle}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.budgetpixel.com/v1/wardrobe/{handle}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"category": "outerwear",
"colors": [
"camel",
"black"
],
"costume_character": "Ada Wong",
"costume_franchise": "Resident Evil",
"description": "Camel mid-length wool blend overcoat with waist belt, black turtleneck, black tailored trousers, black leather dress shoes.",
"handle": "camel_belted_overcoat_outfit",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "outfit",
"mention": "@camel_belted_overcoat_outfit",
"name": "Camel Belted Overcoat Outfit",
"preview_url": "<string>",
"source": "mine",
"tags": [
"minimalist",
"autumn",
"smart"
],
"thumbnail_url": "<string>",
"error": "<string>",
"how_to_use": "<string>",
"picture_url": "<string>",
"status": "processing"
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}Get an outfit
One outfit in full, with the full-size picture a mention sends (a signed link that expires after a few hours). When more than one of your outfits has the handle, your own comes first, then a saved one, then the free library’s: the same order a mention follows.
An outfit’s id instead of its handle reads one of your own outfits in any state: how you
learn that an outfit you added with POST /v1/wardrobe is ready (status), or why it failed.
Free — no credits. Limited to 200 calls per day and 30 a minute per account.
curl --request GET \
--url https://api.budgetpixel.com/v1/wardrobe/{handle} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.budgetpixel.com/v1/wardrobe/{handle}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.budgetpixel.com/v1/wardrobe/{handle}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.budgetpixel.com/v1/wardrobe/{handle}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.budgetpixel.com/v1/wardrobe/{handle}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.budgetpixel.com/v1/wardrobe/{handle}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.budgetpixel.com/v1/wardrobe/{handle}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"category": "outerwear",
"colors": [
"camel",
"black"
],
"costume_character": "Ada Wong",
"costume_franchise": "Resident Evil",
"description": "Camel mid-length wool blend overcoat with waist belt, black turtleneck, black tailored trousers, black leather dress shoes.",
"handle": "camel_belted_overcoat_outfit",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "outfit",
"mention": "@camel_belted_overcoat_outfit",
"name": "Camel Belted Overcoat Outfit",
"preview_url": "<string>",
"source": "mine",
"tags": [
"minimalist",
"autumn",
"smart"
],
"thumbnail_url": "<string>",
"error": "<string>",
"how_to_use": "<string>",
"picture_url": "<string>",
"status": "processing"
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}{
"error": {
"code": "model_not_available",
"message": "<string>",
"type": "invalid_request_error"
}
}Authorizations
API key as a bearer token: Authorization: Bearer bpx_live_xxx
Path Parameters
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.
"outerwear"
["camel", "black"]
On a famous character's outfit (anime, game, film), the character. Absent otherwise. It is in the tags too, so q finds it.
"Ada Wong"
On a famous character's outfit, where the character is from. Absent otherwise.
"Resident Evil"
What the outfit is, word for word as it is added to the prompt with the mention.
"Camel mid-length wool blend overcoat with waist belt, black turtleneck, black tailored trousers, black leather dress shoes."
"camel_belted_overcoat_outfit"
"outfit"
Write this next to a character in an image or video prompt.
"@camel_belted_overcoat_outfit"
"Camel Belted Overcoat Outfit"
The picture at most 800 px on its long side, for a preview (a signed link that expires after a few hours).
mine = made by you; saved = kept from the free library or from another member; house = the free library.
mine, saved, house ["minimalist", "autumn", "smart"]
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).
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).
On an outfit you are adding: processing while its picture is made (its handle is final once ready), or failed with error.
processing, ready, failed