PLplastic-labs
workspaces

Schedule Dream

Changed on

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

Request

  • Base URL
    https://api.honcho.dev
  • Auth
    HTTP bearer

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' | 'card_refresh' required

Types of dreams that can be triggered.

session_idstring nullable

Session ID to scope the dream to if specified

rebuildboolean

card_refresh dreams only: rebuild the peer card solely from observations currently in the collection, without injecting the existing card (use after removals)

Response

Successful Response

Changes

  • v34e34e9b48a23Revision changes
    • info

      added the new optional request property

    • info

      added the new card_refresh enum value to the request property

  • v30730be052dc9Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status