openmemory
Docs
Dreaming

Client-mode dreaming: submit your model's result

POST
/v1/dream/jobs/{id}/result

Validated against the job's output schema and applied under the safety rules: pinned and user-stated facts are never rewritten or removed, and at most max_changes are applied. Every change can be undone.

Authorization

headerAuthorizationBearer <token>

Your space key (om_...). Create one with POST /v1/spaces.

Path Parameters

id*string
Length1 <= length <= 64

Request Body

application/json
  1. body
merges?array<>

Near-duplicate facts to merge into keep_id. Optional new wording for keep_id.

Itemsitems <= 50
Default[]
promotions?array<>

Tier changes, e.g. often-recalled long facts to core.

Itemsitems <= 50
Default[]
contradictions?array<>

Facts that disagree. They are flagged, not changed.

Itemsitems <= 20
Default[]
weekly_digest?|null
proposals?array<>

Unfinished items worth tracking. Stored in the dream.proposals collection with status 'proposed'.

Itemsitems <= 20
Default[]
profile?string

A short profile of the owner built only from the facts given.

Lengthlength <= 4000

Response Body

Applied

application/json
  1. response
id*string
mode*string
status*string

running | awaiting_client | done | failed | undone | abandoned

report*
started_at*string
finished_at*string|null
Example Request
curl -X POST 'https://api.openmemory.sh/v1/dream/jobs/string/result' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "mode": "string",  "status": "string",  "report": {    "property1": null,    "property2": null  },  "started_at": "string",  "finished_at": "string"}

Client-mode dreaming: get the job for your model GET

Returns the waiting job, or null. With start_if_due=true, starts a dream first when the last one is older than the dream interval. Call it from a nightly run, give instructions + input to your model, and submit the JSON it returns.

List recent dream runs and their reports GET

Next Page