Skip to main content

Dream object

All Dream endpoints return the Dream object.
FieldTypeDescription
idstringDream ID, prefixed with drm_
typestringAlways "dream"
statusstringDream status, see Dream status
inputsarrayInput list, see Dream input
outputsarrayOutput list, see Dream output
modelobjectModel used, format {"id": "auto"}
instructionsstringCustom consolidation instructions, max 4096 characters
session_idstring or nullAssociated Dreaming Session ID (populated after execution starts)
usageobjectToken usage statistics
errorobject or nullError details on failure
created_atstringUTC creation time (ISO 8601)
ended_atstring or nullUTC end time (only for terminal states)
archived_atstring or nullUTC archive time

Dream status

ValueDescription
pendingCreated, awaiting execution
runningMemory consolidation in progress
completedConsolidation finished; results in outputs
failedExecution failed; reason in error
canceledCanceled by user

Dream input

Each element in the inputs array:
type valueRequired fieldsDescription
memory_storememory_store_idSpecifies the input Memory Store (required, only one allowed)
sessionssession_idsSpecifies Sessions to prioritize (optional, max 100 IDs)

Dream output

After completion, elements in the outputs array:
FieldTypeDescription
typestringAlways "memory_store"
memory_store_idstringThe consolidated output Memory Store ID
files_touchedarrayPaths of memory files created/modified/deleted

Dream usage

FieldTypeDescription
input_tokensintegerInput token count
output_tokensintegerOutput token count
cache_creation_input_tokensintegerCache creation token count
cache_read_input_tokensintegerCache read token count

Dream error

Error object returned on failure:
FieldTypeDescription
typestringError type (e.g. "no_output", "internal_error")
messagestringError description