Skip to main content
POST
/
v3
/
workspaces
/
{workspace_id}
/
schedule_dream
Schedule Dream
curl --request POST \
  --url https://api.honcho.dev/v3/workspaces/{workspace_id}/schedule_dream \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "observer": "<string>",
  "dream_type": "omni",
  "observed": "<string>",
  "session_id": "<string>"
}
'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string
required

Body

application/json

Dream scheduling parameters

​
observer
string
required

Observer peer name

​
dream_type
enum<string>
required

Type of dream to schedule

Available options:
omni
​
observed
string | null

Observed peer name (defaults to observer if not specified)

​
session_id
string | null

Session ID to scope the dream to if specified

Response

Successful Response