Regenerate one named view (synchronous)
curl --request POST \
--url https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate"
headers = {"X-Api-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate', 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.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$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.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "char_01HXMQ7Z3K8Y2NABCDEFGHJKMR",
"object": "character",
"name": "Aurora the Adventurer",
"status": "ready",
"nudity": "clothed",
"refs": [
{
"pose": "front",
"view": "full_front",
"source": "generated",
"url": "https://storage-host.example/storage/v1/object/sign/characters/full_front.jpg?token=eyJhbGciOi..."
}
],
"views": [
{
"view": "full_front",
"status": "generated",
"url": null,
"nudity": "clothed",
"reason": null,
"detected_view": null,
"made_from": [
"head_front",
"full_front"
]
}
],
"build": {
"missing_views": [
"full_front",
"full_right"
],
"cost_credits": 123,
"per_view_credits": 123
},
"created_at": "2026-05-08T10:00:00Z",
"updated_at": "2026-05-08T10:00:00Z",
"client_reference_id": "bot_8472",
"attributes": {
"gender": "female",
"age": 28,
"ethnicity": "east-asian",
"hair_color": "black",
"hair_style": "shoulder-length straight",
"eye_color": "brown",
"body_type": "athletic",
"additional_details": "small scar above right eyebrow; warm smile"
},
"error_message": null,
"aurous_version": "2026-08-26"
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}Characters
Regenerate a view
Re-render one named view of a character, or add a view the character does not have yet.
POST
/
v1
/
characters
/
{id}
/
refs
/
{view}
/
regenerate
Regenerate one named view (synchronous)
curl --request POST \
--url https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate \
--header 'X-Api-Key: <api-key>'import requests
url = "https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate"
headers = {"X-Api-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-Api-Key': '<api-key>'}};
fetch('https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate', 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.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>"
],
]);
$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.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-Api-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate")
.header("X-Api-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aurous-labs.com/v1/characters/{id}/refs/{view}/regenerate")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "char_01HXMQ7Z3K8Y2NABCDEFGHJKMR",
"object": "character",
"name": "Aurora the Adventurer",
"status": "ready",
"nudity": "clothed",
"refs": [
{
"pose": "front",
"view": "full_front",
"source": "generated",
"url": "https://storage-host.example/storage/v1/object/sign/characters/full_front.jpg?token=eyJhbGciOi..."
}
],
"views": [
{
"view": "full_front",
"status": "generated",
"url": null,
"nudity": "clothed",
"reason": null,
"detected_view": null,
"made_from": [
"head_front",
"full_front"
]
}
],
"build": {
"missing_views": [
"full_front",
"full_right"
],
"cost_credits": 123,
"per_view_credits": 123
},
"created_at": "2026-05-08T10:00:00Z",
"updated_at": "2026-05-08T10:00:00Z",
"client_reference_id": "bot_8472",
"attributes": {
"gender": "female",
"age": 28,
"ethnicity": "east-asian",
"hair_color": "black",
"hair_style": "shoulder-length straight",
"eye_color": "brown",
"body_type": "athletic",
"additional_details": "small scar above right eyebrow; warm smile"
},
"error_message": null,
"aurous_version": "2026-08-26"
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}{
"error": {
"type": "invalid_request",
"code": "balance_too_low",
"message": "Team available balance is 1.5 credits, generation requires 2.0.",
"doc_url": "https://docs.aurous-labs.com/errors#balance_too_low",
"request_id": "req_01HXMQ7Z3K8Y2VNABCDEFGHJKM",
"param": "prompt",
"reason": "wrong_view",
"detected_view": "full_left"
}
}POST /v1/characters/{id}/refs/{view}/regenerate re-renders one of the eight named views and returns the updated character. A view the character does not have yet is added.
Every character created on or after 2026-09-14 carries all eight views, so on a new character this route only re-renders. Characters created before that date carry six — head_front, upper_front, lower_front, upper_back, lower_back, full_left — and this route is the only way to add full_right to one while it is ready. (Resynthesize, available while reviewing or failed, also brings an older character to eight.) full_front can also be reached through the deprecated body form ({ "pose": "front" }), which aliases onto it.
The call is synchronous: it blocks until the view is rendered. A render takes 60–180 seconds — set a client timeout of at least 300 seconds.
A view holding a photo you uploaded cannot be regenerated. Your photo is the ground truth the character is rendered from, so re-rolling it would discard the identity and charge you for the privilege: the call returns
400 reference_uploaded with param: view, and nothing is charged. Replace it with PUT /v1/characters/{id}/refs/{view} instead, or remove it from a draft with DELETE /v1/characters/{id}/refs/{view} and let a build render it. Check views[].status — uploaded means this route will refuse.The request is charged before the render is dispatched. Aborting the HTTP request client-side does not cancel the render and does not refund the credits — you simply stop waiting for a response you already paid for. A credit refund happens only when the render itself fails server-side. If your HTTP client’s default timeout is 30 or 60 seconds, raise it before you call this route.
When to use
- One view came back wrong and the rest are fine.
- An older six-view character needs
full_frontorfull_rightfor a video or an edit — this route is the only way to addfull_rightto areadyone. Areviewingorfailedcharacter can instead be brought to eight with Resynthesize.
Path parameters
| Parameter | Description |
|---|---|
id | Opaque character id (char_…). |
view | One of head_front, upper_front, lower_front, upper_back, lower_back, full_left, full_front, full_right (canonical order). Anything else is 400 invalid_format (param: "view"). |
Examples
curl -X POST https://api.aurous-labs.com/v1/characters/char_01HXMQ7Z3K8Y2VNABCDEFGHJKM/refs/full_front/regenerate \
-H "X-Api-Key: $AUROUS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"
const character = await fetch(
`https://api.aurous-labs.com/v1/characters/${id}/refs/full_front/regenerate`,
{ method: "POST", headers: { "X-Api-Key": process.env.AUROUS_API_KEY!, "Idempotency-Key": crypto.randomUUID() } },
).then((r) => r.json());
console.log(character.views.find((v) => v.view === "full_front").status); // "generated"
import os, uuid, requests
r = requests.post(
f"https://api.aurous-labs.com/v1/characters/{character_id}/refs/full_front/regenerate",
headers={"X-Api-Key": os.environ["AUROUS_API_KEY"], "Idempotency-Key": str(uuid.uuid4())},
timeout=300,
).json()
print(next(v for v in r["views"] if v["view"] == "full_front")["status"])
Limits
- Cost:
build.per_view_credits(read it from the character; do not hardcode). Charged up front; refunded automatically if the render fails. - Rate limit: bucket
characters_synthesize— 15 requests/min sustained, 30 burst per team. Shared acrossPOST /v1/characters,POST /v1/characters/{id}/refs/regenerate,POST /v1/characters/{id}/refs/{view}/regenerate,POST /v1/characters/{id}/resynthesizeandPOST /v1/characters/{id}/build— five routes, one bucket. - Idempotency: pass
Idempotency-Key. Because the view is part of the path, use one key per view — reusing a key across two views returns409 idempotency_key_in_use.
Errors
| Code | HTTP | When |
|---|---|---|
invalid_format | 400 | view is not one of the eight names. |
character_status_invalid | 400 | The character is not ready or reviewing (the message names the current status). |
reference_uploaded | 400 | The view holds a photo you uploaded. param is view. Replace it with PUT /v1/characters/{id}/refs/{view} instead. Nothing is charged. |
invalid_request | 400 | The character has no references to condition the render on (zero refs). |
invalid_api_key | 401 | Missing, malformed, or revoked X-Api-Key. |
balance_too_low | 402 | Team credits below the per-view price. |
insufficient_scope | 403 | The key does not carry the write scope. |
resource_not_found | 404 | Unknown id, soft-deleted character, or cross-team. |
character_busy | 409 | A render is in flight; retry after Retry-After seconds. |
idempotency_key_in_use | 409 | Same Idempotency-Key used with a different body or route. |
too_many_requests | 429 | Bucket exhausted. |
provider_unavailable | 503 | Synthesis is paused for your team; Retry-After is set. |
Common pitfalls
- The legacy body form
POST /v1/characters/{id}/refs/regeneratewith{ "pose": ... }still works but reaches only four views through a fixed alias table — see its page. Its2xxresponses carryDeprecation: trueand aLinkheader pointing here. Prefer this route. views[]andrefs[]describe the same references;refs[].posekeeps the original five-value label for compatibility,refs[].viewcarries the view name. See Views and lifecycle.- Check
views[].statusbefore offering a regenerate in your UI:generatedcan be re-rolled here,uploadedcannot.
These changes ship on the existing
2026-08-26 contract. No Aurous-Version pin isolates them: the version catalogue carries image and video pricing pointers only, not character pricing or the size of the reference set. Pinning an earlier Aurous-Version restores neither the smaller reference set nor the previous price. A character created before 2026-09-14 keeps the references it already has — add either of the two newer views on demand with POST /v1/characters/{id}/refs/{view}/regenerate; every character created on or after that date carries eight.Authorizations
Your team API key (starts with al_live_).
Headers
Stripe-style idempotency key (1-256 chars). Same key + same canonical-JSON body returns the cached response with Aurous-Idempotent-Replayed: true. Same key against a different route (e.g. previously used on /v1/images) returns 409 invalid_request / idempotency_key_in_use. Replay window is 24 hours. Absent header is treated as non-idempotent (each call processes anew). One key per view: the view is part of the path, so reusing a key across two views returns 409 idempotency_key_in_use.
Optional API version pin (YYYY-MM-DD). Omit the header to receive the platform default, currently 2026-08-26.
Pattern:
^\d{4}-\d{2}-\d{2}$Example:
"2026-08-26"
Path Parameters
Opaque character ID
Example:
"char_01HXMQ7Z3K8Y2NABCDEFGHJKMR"
The view to render
Available options:
head_front, upper_front, lower_front, upper_back, lower_back, full_left, full_front, full_right Response
View rendered; updated character returned
Opaque character ID.
Example:
"char_01HXMQ7Z3K8Y2NABCDEFGHJKMR"
Discriminator
Available options:
character Example:
"character"
Display name.
Example:
"Aurora the Adventurer"
Lifecycle state. draft: references are being assembled; nothing has been charged and the character cannot be used for generation. New lifecycle states may be added in future — treat any status other than ready as "not yet usable". synthesizing: references are being built. ready: usable on POST /v1/images — both create flows advance here on their own. reviewing: reached only after POST /:id/resynthesize or POST /:id/build; call POST /:id/save to return to ready. failed: the build failed; error_message carries the reason and POST /:id/build (builder characters) or POST /:id/resynthesize retries. deleted: soft-deleted (filtered out of the list endpoint).
Available options:
draft, synthesizing, reviewing, ready, failed, deleted Example:
"ready"
What the reference set is rendered as — nude unless you chose clothed, or — when you omitted nudity — your team's default is clothed. An explicit value always wins. Fixed once the references are built.
Available options:
nude, clothed Example:
"clothed"
Reference images, one per view the character has. A character built today has eight; an older one can have fewer than eight (typically six, some of the oldest four). Do not assume a count — read views[], the canonical read model for new integrations, or build.missing_views. refs[] lists only the references that exist.
Show child attributes
Show child attributes
One entry per named view, in canonical order — every reference that maps to a named view, keyed by view, plus what is missing or was rejected. A reference from before named views existed (refs[].view is other) appears only in refs[].
Show child attributes
Show child attributes
What a build would render and cost right now. Always present.
Show child attributes
Show child attributes
Creation timestamp (ISO 8601).
Example:
"2026-05-08T10:00:00Z"
Last-update timestamp (ISO 8601).
Example:
"2026-05-08T10:00:00Z"
Caller-supplied reference echoed back (the value sent on create). Null if unset.
Example:
"bot_8472"
Character attributes. Null when unset.
Show child attributes
Show child attributes
Machine-readable failure code from the most recent synthesize/resynthesize attempt. One of synthesis_failed, synthesis_timeout, provider_unavailable — a closed set to switch on, not customer-facing prose. Null when the most recent attempt succeeded (or none has run yet). Set on failed, but NOT failed-exclusive: a failed resynthesize restores the character to its prior working status (reviewing) rather than overwriting a good generation, so a reviewing row can carry a non-null code here — check this field for failure, not status. Cleared on the next resynthesize attempt and on success.
Example:
null
API contract version applied at the time this row was minted (D25 — frozen for replay across future version bumps).
Example:
"2026-08-26"