Get a character
curl --request GET \
--url https://api.budgetpixel.com/v1/characters/{handle} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.budgetpixel.com/v1/characters/{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/characters/{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/characters/{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/characters/{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/characters/{handle}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.budgetpixel.com/v1/characters/{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{
"character": {
"age": "<string>",
"catchphrase": "Obviously.",
"creator": "<string>",
"gender": "<string>",
"handle": "barry",
"mention": "@barry",
"name": "Barry",
"page_url": "https://budgetpixel.com/characters/bfaa78ab-a3c0-4537-b979-b5c851cd6853",
"picture_tags": [
"avatar",
"full_body",
"expressions",
"selfie"
],
"preview_url": "<string>",
"source": "official",
"summary": "<string>",
"title": "Rich in his head",
"traits": [
"<string>"
],
"trend_rank": 123,
"backstory": "<string>",
"consistency_rules": "<string>",
"directing_notes": "<string>",
"full_resolution": true,
"how_to_use": "<string>",
"in_their_head": "<string>",
"look": "<string>",
"personality": "<string>",
"pictures": [
{
"caption": "<string>",
"default": true,
"height": 123,
"label": "Full body",
"mention": "@barry.full_body",
"tag": "full_body",
"url": "<string>",
"width": 123
}
],
"reality": "<string>",
"signature_details": "<string>",
"speaking_style": "<string>",
"supported_models": {
"image": [
"<string>"
],
"video": [
"<string>"
]
},
"usage": "<string>"
},
"note": "<string>"
}{
"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"
}
}Characters
Get a character
One character in full: the look word for word (the text that goes into the prompt with the mention), the profile (personality, speaking style, backstory, directing notes, signature details, consistency rules), every picture with a download link, and the models a mention works on.
For the BudgetPixel AI influencers and your own characters the links are the
full-size files, so you can use the character with other tools too; usage gives the
terms for the influencers. A collected character’s pictures are preview size. Links are
signed and expire after a few hours.
Free — no credits. Limited to 100 calls per day per account.
GET
/
characters
/
{handle}
Get a character
curl --request GET \
--url https://api.budgetpixel.com/v1/characters/{handle} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.budgetpixel.com/v1/characters/{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/characters/{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/characters/{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/characters/{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/characters/{handle}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.budgetpixel.com/v1/characters/{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{
"character": {
"age": "<string>",
"catchphrase": "Obviously.",
"creator": "<string>",
"gender": "<string>",
"handle": "barry",
"mention": "@barry",
"name": "Barry",
"page_url": "https://budgetpixel.com/characters/bfaa78ab-a3c0-4537-b979-b5c851cd6853",
"picture_tags": [
"avatar",
"full_body",
"expressions",
"selfie"
],
"preview_url": "<string>",
"source": "official",
"summary": "<string>",
"title": "Rich in his head",
"traits": [
"<string>"
],
"trend_rank": 123,
"backstory": "<string>",
"consistency_rules": "<string>",
"directing_notes": "<string>",
"full_resolution": true,
"how_to_use": "<string>",
"in_their_head": "<string>",
"look": "<string>",
"personality": "<string>",
"pictures": [
{
"caption": "<string>",
"default": true,
"height": 123,
"label": "Full body",
"mention": "@barry.full_body",
"tag": "full_body",
"url": "<string>",
"width": 123
}
],
"reality": "<string>",
"signature_details": "<string>",
"speaking_style": "<string>",
"supported_models": {
"image": [
"<string>"
],
"video": [
"<string>"
]
},
"usage": "<string>"
},
"note": "<string>"
}{
"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 character's handle, with or without the @ (barry, @barry).