Skip to main content
GET
/
v1
/
characters
/
{id}
Retrieve a character
curl --request GET \
  --url https://api.aurous-labs.com/v1/characters/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "char_01HXMQ7Z3K8Y2NABCDEFGHJKMR",
  "object": "character",
  "name": "Aurora the Adventurer",
  "status": "ready",
  "refs": [
    {
      "pose": "front",
      "url": "https://api.aurous-labs.com/storage/.../front.bin?token=…"
    }
  ],
  "created_at": "2026-05-08T10:00:00Z",
  "updated_at": "2026-05-08T10:00:00Z",
  "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-05-15"
}

Documentation Index

Fetch the complete documentation index at: https://docs.aurous-labs.com/llms.txt

Use this file to discover all available pages before exploring further.

GET /v1/characters/{id} returns a single character. Use it to:
  • Poll a synthesize-flow character until status transitions from synthesizing to reviewing (or failed).
  • Read the refs[] array for proxy URLs you can render in your UI.
  • Inspect attributes for the typed identity fields the platform stored.

​
Status lifecycle

StatusMeaningCustomer action
synthesizingSynthesize-flow generation running.Poll. Typical completion 30–90 seconds.
reviewingSynthesize completed; refs ready for human approval.Inspect refs. Call POST /v1/characters/{id}/save to publish, or POST /v1/characters/{id}/resynthesize to retry.
readyUsable as character_id on POST /v1/images.Reference on generation.
failedSynthesize dispatch failed. error_message populated.Call POST /v1/characters/{id}/resynthesize to retry, or DELETE /v1/characters/{id} to discard.
Soft-deleted characters return 404 resource_not_found on this endpoint — the V1 surface treats them as gone for IDOR safety. If you need to confirm a soft-delete landed, the 404 itself is the confirmation.

​
Examples

curl https://api.aurous-labs.com/v1/characters/char_01HXMQ7Z3K8Y2ABCDEFGHJKM \
  -H "X-Api-Key: $AUROUS_API_KEY"

​
Limits

  • Rate limit: bucket characters_get — 120 requests/min sustained, 240 burst per team.

​
Errors

CodeHTTPWhen
resource_not_found404Unknown ID, soft-deleted character, or character belongs to a different team. The 404 is intentional — cross-team existence is never leaked.

​
Common pitfalls

  • refs[].url is a proxy URL — do not assume it points at any specific storage host. Treat it as opaque and re-fetch as needed; URLs are valid for ~24h.
  • Polling at 2-second intervals is plenty for synthesize. Tighter polling only burns rate-limit budget.
  • Soft-deleted characters return 404 on this endpoint — if you want to keep an audit trail of past characters, mirror them in your own database before calling DELETE.

Authorizations

​
X-Api-Key
string
header
required

Your team API key (starts with al_live_).

Headers

​
Aurous-Version
string

Optional API version pin (YYYY-MM-DD). Defaults to your team's pinned version, or the system default 2026-05-15 for unauthenticated requests.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-05-15"

Path Parameters

​
id
string
required

Opaque character ID

Example:

"char_01HXMQ7Z3K8Y2NABCDEFGHJKMR"

Response

Character details

​
id
string
required

Opaque character ID.

Example:

"char_01HXMQ7Z3K8Y2NABCDEFGHJKMR"

​
object
enum<string>
required

Discriminator

Available options:
character
Example:

"character"

​
name
string
required

Display name.

Example:

"Aurora the Adventurer"

​
status
enum<string>
required

Lifecycle state. synthesizing: synthesize flow running. reviewing: synthesize completed, awaiting POST /:id/save. ready: usable on POST /v1/images. failed: synthesize failed; use POST /:id/resynthesize to retry. deleted: soft-deleted (filtered out of list endpoint).

Available options:
synthesizing,
reviewing,
ready,
failed,
deleted
Example:

"ready"

​
refs
object[]
required

Reference images (typically 4 poses).

​
created_at
string
required

Creation timestamp (ISO 8601).

Example:

"2026-05-08T10:00:00Z"

​
updated_at
string
required

Last-update timestamp (ISO 8601).

Example:

"2026-05-08T10:00:00Z"

​
attributes
object

Character attributes. Null when unset.

​
error_message
object

Error message when status is failed. Null otherwise.

Example:

null

​
aurous_version
string

API contract version applied at the time this row was minted (D25 — frozen for replay across future version bumps).

Example:

"2026-05-15"