Sign in
Characters V2

Get Character Status

Returns the current processing status of a character. Poll this endpoint after generate/save operations to track progress.

get/api/v2/characters/{characterGuid}/status

Path parameters

characterGuidstring uuid required

Character GUID from the generate step

Response

Character status retrieved

characterGuidstring uuid
status'draft' | 'generating' | 'ready' | 'saving' | 'saved' | 'failed'

V2 character processing status:

  • draft: Initial state
  • generating: AI generation in progress
  • ready: Generation complete, ready to save
  • saving: Save in progress
  • saved: Fully saved and ready to use
  • failed: Processing failed (check errorMessage)
characterIdinteger

Populated when status is 'saved'

errorMessagestring nullable

Error message if processing failed

createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this endpoint across all 1 revision of this API.