Sign in
Digital Twins

Get Digital Twin Status

Returns the current processing status of a digital twin. Poll this endpoint after create/update operations to track progress. When status is 'active', the characterId field is populated and can be used for subsequent update calls.

get/api/v1/digital-twins/status/{digitalTwinId}

Path parameters

digitalTwinIdstring uuid required

Digital Twin UUID returned from the create endpoint

Response

Digital twin status retrieved

digitalTwinIdstring uuid
status'pending' | 'active' | 'draft' | 'inactive'

Digital twin processing status:

  • pending: Creation/update in progress
  • active: Digital twin is ready and live
  • draft: Initial state before processing
  • inactive: Deactivated
characterIdinteger

Populated when status is 'active' - use this for update calls

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.