Sign in
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' | '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

Changed in 3 of the 10 revisions of this API.6

  • v34e34e9b48a232See the full diff
    • ○

      added the new optional request property rebuild

      new-optional-request-property

    • ○

      added the new card_refresh enum value to the request property dream_type

      request-property-enum-value-added

  • v30730be052dc92See the full diff
    • ○

      added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • ○

      added the optional property detail/items/input to the response with the 422 status

      response-optional-property-added

  • v3839ffcc7e8bb2See the full diff
    • ○

      the request property session_id became optional

      request-property-became-optional

    • ○

      request property session_id list-of-types was widened by adding types null to media type application/json

      request-property-list-of-types-widened