v7

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-024655133.4 KB

workspaces

Schedule Dream

Manually schedule a dream task for a specific collection.

This endpoint bypasses all automatic dream conditions (document threshold, minimum hours between dreams) and schedules the dream task for a future execution.

Currently this endpoint only supports scheduling immediate dreams. In the future, users may pass a cron-style expression to schedule dreams at specific times.

post/v3/workspaces/{workspace_id}/schedule_dream

Path parameters

workspace_idstring required

Request body

observerstring required

Observer peer name

observedstring nullable

Observed peer name (defaults to observer if not specified)

dream_type'omni' required

Types of dreams that can be triggered.

session_idstring nullable

Session ID to scope the dream to if specified

Response

Successful Response