Get Dream

curl --request GET \
  --url https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}', 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/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
  "created": [
    {
      "conclusion": {
        "id": "<string>",
        "status": "current",
        "content": "<string>",
        "level": "explicit",
        "removed_in_run": "<string>"
      },
      "sources": [
        {
          "id": "<string>",
          "status": "current",
          "content": "<string>",
          "level": "explicit",
          "removed_in_run": "<string>"
        }
      ],
      "specialist": "<string>"
    }
  ],
  "removed": [
    {
      "id": "<string>",
      "content": "<string>",
      "level": "explicit",
      "replaced_by": "<string>",
      "specialist": "<string>"
    }
  ],
  "dream_type": "<string>",
  "trigger_reason": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "pruned_at": "2023-11-07T05:31:56Z",
  "peer_card": {
    "before": [
      "<string>"
    ],
    "after": [
      "<string>"
    ]
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

GET

workspaces

{workspace_id}

dreams

{run_id}

Get Dream

curl --request GET \
  --url https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}', 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/{run_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.honcho.dev/v3/workspaces/{workspace_id}/dreams/{run_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "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",
  "created": [
    {
      "conclusion": {
        "id": "<string>",
        "status": "current",
        "content": "<string>",
        "level": "explicit",
        "removed_in_run": "<string>"
      },
      "sources": [
        {
          "id": "<string>",
          "status": "current",
          "content": "<string>",
          "level": "explicit",
          "removed_in_run": "<string>"
        }
      ],
      "specialist": "<string>"
    }
  ],
  "removed": [
    {
      "id": "<string>",
      "content": "<string>",
      "level": "explicit",
      "replaced_by": "<string>",
      "specialist": "<string>"
    }
  ],
  "dream_type": "<string>",
  "trigger_reason": "<string>",
  "finished_at": "2023-11-07T05:31:56Z",
  "pruned_at": "2023-11-07T05:31:56Z",
  "peer_card": {
    "before": [
      "<string>"
    ],
    "after": [
      "<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

run_id

string

required

The dream's run ID

Response

Successful Response

A dream run with every change it committed.

string

required

The dream's run ID

observer_id

string

required

The peer whose representation the dream changed

observed_id

string

required

The peer the representation is about

status

enum<string>

required

failed and interrupted runs can still have changes: each change is committed as it is made.

Available options:

running,

completed,

failed,

interrupted

created_count

integer

required

Conclusions the dream created

removed_count

integer

required

Conclusions the dream removed

peer_card_updated

boolean

required

Whether the dream changed the peer card

started_at

string<date-time>

required

created

DreamCreatedConclusion · object[]

required

Show child attributes

removed

DreamRemovedConclusion · object[]

required

Show child attributes

dream_type

string | null

The kind of dream, e.g. omni (deduction and induction) or a card refresh

trigger_reason

string | null

What scheduled the dream, e.g. document_threshold or manual

finished_at

string<date-time> | null

pruned_at

string<date-time> | null

When retention first deleted some of this run's changes. Past the retention window a run keeps only the created conclusions that still exist; removed and peer_card are gone. The counts stay as the dream recorded them.

peer_card

DreamPeerCardChange · object | null

The peer card before the dream's first update and after its last.

Show child attributes

API Documentation

workspaces

dreams

peers

sessions

scopes

messages

conclusions

webhooks

miscellaneous

Get Dream

Authorizations

Path Parameters

Response