List Dreams
curl --request POST \
--url https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"observed_id": "<string>",
"observer_id": "<string>"
}
'import requests
url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list"
payload = {
"observed_id": "<string>",
"observer_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({observed_id: '<string>', observer_id: '<string>'})
};
fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'observed_id' => '<string>',
'observer_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list"
payload := strings.NewReader("{\n \"observed_id\": \"<string>\",\n \"observer_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"observed_id\": \"<string>\",\n \"observer_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"observed_id\": \"<string>\",\n \"observer_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"observer_id": "<string>",
"observed_id": "<string>",
"status": "running",
"created_count": 123,
"removed_count": 123,
"peer_card_updated": true,
"started_at": "2023-11-07T05:31:56Z",
"dream_type": "<string>",
"trigger_reason": "<string>",
"finished_at": "2023-11-07T05:31:56Z",
"pruned_at": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"page": 2,
"size": 2,
"pages": 1
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}dreams
List Dreams
List dream runs, newest first. Results are paginated.
Each run records what one dream changed in a representation. Filter by
observed_id for a peer’s history, and add observer_id for a single
representation. Runs are kept for the server’s retention window (30 days
by default).
POST
/
v3
/
workspaces
/
{workspace_id}
/
dreams
/
list
List Dreams
curl --request POST \
--url https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"observed_id": "<string>",
"observer_id": "<string>"
}
'import requests
url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list"
payload = {
"observed_id": "<string>",
"observer_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({observed_id: '<string>', observer_id: '<string>'})
};
fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'observed_id' => '<string>',
'observer_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list"
payload := strings.NewReader("{\n \"observed_id\": \"<string>\",\n \"observer_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"observed_id\": \"<string>\",\n \"observer_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"observed_id\": \"<string>\",\n \"observer_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"items": [
{
"id": "<string>",
"observer_id": "<string>",
"observed_id": "<string>",
"status": "running",
"created_count": 123,
"removed_count": 123,
"peer_card_updated": true,
"started_at": "2023-11-07T05:31:56Z",
"dream_type": "<string>",
"trigger_reason": "<string>",
"finished_at": "2023-11-07T05:31:56Z",
"pruned_at": "2023-11-07T05:31:56Z"
}
],
"total": 1,
"page": 2,
"size": 2,
"pages": 1
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Query Parameters
Page number (offset mode)
Required range:
1 <= x <= 2147483647Page size
Required range:
1 <= x <= 100Opt in to cursor pagination. Send an empty value for the first page, then the next_page value from each response. When set, page is ignored and the response is a cursor page with no total.
Body
application/json
Response
Successful Response
- Page[DreamRun]
- CursorPage[DreamRun]
Show child attributes
Show child attributes
Number of matching rows, exact up to the server's PAGINATION_COUNT_LIMIT (default 100000) and reported as that limit plus one when there are more. While a next page exists it is at least one more than this page's last row, so pages always reaches the end of the list.
Required range:
x >= 0Required range:
x >= 1Required range:
x >= 1Required range:
x >= 0Was this page helpful?