> ## Documentation Index > Fetch the complete documentation index at: https://docs.budgetpixel.com/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi.yaml get /characters/{handle} openapi: 3.1.0 info: contact: email: support@budgetpixel.com name: BudgetPixel Support description: > The BudgetPixel developer API for programmatic image, video, music and sound-effect generation. Generation is **asynchronous**: you create a job, then poll its status until it reaches a terminal state (`succeeded` / `failed`). You are charged in credits only on success — never for failures, timeouts, or content blocked before generation. **Authentication.** All requests require an API key sent as a bearer token: Authorization: Bearer bpx_live_xxx Create and manage keys from your BudgetPixel account dashboard. The developer API is available on **every paid plan**. On the **Free** plan, API keys can call the free library searches only: `GET /v1/stock/images`, `GET /v1/stock/sound-effects` and `GET /v1/stock/music`. **Pricing.** API usage is metered in credits at each model's published price (see `GET /v1/models`), and your plan's model discounts and active promotions apply to API charges exactly as they do on the web — `POST /v1/cost` quotes your discounted price. Pro and Ultra plans include a daily free-models allowance (a shared pool of free generations per day across qualified image models such as FLUX 2 Klein and Qwen-Image) that covers API requests too — the standard price applies once the day's pool is used. Other promotional free daily generations remain web/app-only. Failed generations are never charged. **Rate limits.** Requests are limited per minute: **600 requests/min per API key** and **1200 requests/min per source IP** (defaults; subject to tuning). Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset` (seconds until the window resets). Exceeding a limit returns HTTP `429` with a `Retry-After` header — wait that long before retrying. Rejected requests still count against the window, so a tight retry loop keeps you limited; back off instead. Generation jobs additionally have a per-plan concurrency cap (the same one as the web workshop), independent of these request limits. `POST /v1/uploads` also has a dedicated **60 uploads/min per account** cap (it's free/unmetered) on top of these limits. Every `429` this API returns carries `Retry-After`, including a full concurrency queue (a suggested wait) and the monthly spend limit (seconds until the month resets). **Characters.** Write `@handle` in the prompt of an image or video generation to cast a character: one of the free BudgetPixel AI influencers (`@barry`, `@rosa`, ...) or a character of your own. Its picture and look go with the mention, so the same face appears in every post. `GET /v1/characters` lists the ones you can cast, `GET /v1/characters/{handle}` gives one in full with every picture, and `POST /v1/characters/recommend` picks influencers for a brief. **Output retention.** Generated files are kept for 24 hours after the job is created. Job status responses give the exact time as `expires_at`; after it, `expired` is `true` and no download URLs are returned. title: BudgetPixel API version: '2026-06-20' servers: - description: Production url: https://api.budgetpixel.com/v1 security: - ApiKeyAuth: [] tags: - description: Account and credit balance name: Account - description: Discover available models and pricing name: Models - description: Upload input media for image/video generation name: Uploads - description: Image job status name: Images - description: FLUX image models name: Black Forest Labs - description: SeeDream image models name: Bytedance - description: Video job status name: Videos - description: Kuaishou Kling video models name: Kling - description: SeeDance video models name: ByteDance (SeeDance) - description: Music and sound-effect job status name: Audios - description: Music generation models name: Music - description: Text-to-sound-effect models (priced per second) name: Sound Effects - description: >- Image-to-3D models — a picture in, a textured 3D model (GLB, plus FBX/USDZ/STL on Meshy) out name: 3D Models - description: Format conversion for images, video, and audio name: Conversions - description: Publish posts to your BudgetPixel feed and enter clan themes name: Social - description: Cast BudgetPixel AI influencers and your own characters with @mentions name: Characters - description: Content moderation — NSFW rating and CSAM detection name: Moderation - description: Content classification — music genre detection name: Classification - description: >- Search the free stock image library — available on every plan, including Free name: Stock Images - description: >- Search the free sound effect library — available on every plan, including Free name: Stock Sound Effects - description: >- Search the free background music library — available on every plan, including Free name: Stock Music - description: >- Turn a video into a depth map video to guide other video models with its structure and motion name: Depth Maps paths: /characters/{handle}: get: tags: - Characters summary: Get a character description: > 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. operationId: getCharacter parameters: - description: The character's handle, with or without the `@` (`barry`, `@barry`). in: path name: handle required: true schema: type: string responses: '200': content: application/json: schema: properties: character: $ref: '#/components/schemas/CharacterDetail' note: type: string type: object description: The character. '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooManyRequests' components: schemas: CharacterDetail: allOf: - $ref: '#/components/schemas/CharacterCard' - properties: backstory: type: string consistency_rules: type: string directing_notes: description: How to direct the character in a scene. type: string full_resolution: description: >- `true` for the influencers and your own characters: the links are the full-size files. A collected character's pictures are preview size. type: boolean how_to_use: type: string in_their_head: description: How the character sees themselves. type: string look: description: >- The character's look, word for word: the text that goes into the prompt with the mention. Reuse it with other tools. type: string personality: type: string pictures: items: $ref: '#/components/schemas/CharacterPicture' type: array reality: description: How everyone else sees them. type: string signature_details: description: >- Details that must appear for the character to read as themselves. type: string speaking_style: type: string supported_models: description: Model ids a mention works on. properties: image: items: type: string type: array video: items: type: string type: array type: object usage: description: >- For the influencers: the terms for using their pictures, including with other tools. type: string type: object CharacterCard: description: A character you can cast by writing its `mention` in a prompt. properties: age: type: string catchphrase: example: Obviously. type: string creator: description: >- `BudgetPixel` for the influencers; the creator's username for a collected character. type: string gender: type: string handle: example: barry type: string mention: description: Write this in an image or video prompt to cast the character. example: '@barry' type: string name: example: Barry type: string page_url: example: >- https://budgetpixel.com/characters/bfaa78ab-a3c0-4537-b979-b5c851cd6853 format: uri type: string picture_tags: description: >- Tags of the character's pictures. `@handle.tag` casts with that picture instead of the default one. example: - avatar - full_body - expressions - selfie items: type: string type: array preview_url: description: >- A preview-size picture (a signed link that expires after a few hours). format: uri type: string source: description: >- `official` = a free BudgetPixel AI influencer; `mine` = your own character; `collected` = one you collected from the marketplace. enum: - official - mine - collected type: string summary: description: One sentence on who they are. type: string title: example: Rich in his head type: string traits: items: type: string type: array trend_rank: description: >- 1-3: among the influencers the most people used this week. Absent otherwise. type: integer type: object CharacterPicture: properties: caption: type: string default: description: The picture a bare `@handle` casts. type: boolean height: type: integer label: example: Full body type: string mention: description: Present on the picture that `@handle.tag` casts. example: '@barry.full_body' type: string tag: example: full_body type: string url: description: Signed download link; expires after a few hours. format: uri type: string width: type: integer type: object Error: properties: error: properties: code: description: Stable machine-readable code. example: model_not_available type: string message: type: string type: description: Error category. example: invalid_request_error type: string required: - type - code - message type: object required: - error type: object ModerationBlocked: description: >- Returned (with HTTP 400) when the input content moderation gate blocks a generation request. The block is a property of the request's prompt or input media — reword the prompt or change the input and retry. Branch on `restriction_reason`, which is stable and machine-readable. properties: error: description: Human-readable explanation of the block. type: string restriction_reason: description: Stable machine-readable block reason. enum: - input_csam - input_explicit_adult - input_upload_nudity - input_celebrity_likeness - strict_model_nsfw type: string required: - error - restriction_reason type: object QueueFull: description: | `429` body when your account already has as many jobs of this kind (image, video or audio) in flight as its concurrency cap allows. Submit the next job when one of your running jobs finishes. properties: active_jobs: description: Jobs of this kind in flight right now. type: integer code: enum: - queue_full type: string error: description: Human-readable message. type: string queue_full: enum: - true type: boolean queue_limit: description: Your concurrency cap for this kind of job. type: integer retry_after_seconds: description: Same value as the `Retry-After` header. type: integer required: - error - code - queue_full - queue_limit - active_jobs - retry_after_seconds type: object responses: BadRequest: content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/ModerationBlocked' description: >- The request was malformed, referenced an unavailable model, or was blocked by input content moderation (moderation blocks carry a `restriction_reason` — see ModerationBlocked). Unauthorized: content: application/json: schema: $ref: '#/components/schemas/Error' description: Missing or invalid API key. NotFound: content: application/json: schema: $ref: '#/components/schemas/Error' description: The requested job was not found. TooManyRequests: content: application/json: schema: oneOf: - $ref: '#/components/schemas/Error' - $ref: '#/components/schemas/QueueFull' description: > A limit was reached. Every `429` carries `Retry-After` (seconds). The per-minute rate limit, the upload limit and the hourly API post cap answer with the `Error` envelope, code `rate_limited`. The monthly spend limit answers with code `monthly_spend_limit_reached`, and its `Retry-After` counts down to the start of next month (raising the limit in the console clears it sooner). A full concurrency queue answers with the flat `QueueFull` body (3D jobs: the `Error` envelope with code `queue_full`); its `Retry-After` is a suggested wait, because a slot frees as soon as one of your running jobs finishes. headers: Retry-After: description: Seconds to wait before retrying. schema: minimum: 1 type: integer securitySchemes: ApiKeyAuth: bearerFormat: bpx_live_* description: 'API key as a bearer token: Authorization: Bearer bpx_live_xxx' scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.