Batch Get Conversation Events - OpenHands Docs

Batch Get Conversation Events

curl --request GET \
  --url https://api.example.com/api/conversations/{conversation_id}/events \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

import requests

url = "https://api.example.com/api/conversations/{conversation_id}/events"

payload = ["<string>"]
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify(['<string>'])
};

fetch('https://api.example.com/api/conversations/{conversation_id}/events', 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.example.com/api/conversations/{conversation_id}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.example.com/api/conversations/{conversation_id}/events"

	payload := strings.NewReader("[\n  \"<string>\"\n]")

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

	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.get("https://api.example.com/api/conversations/{conversation_id}/events")
  .header("Content-Type", "application/json")
  .body("[\n  \"<string>\"\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/conversations/{conversation_id}/events")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n  \"<string>\"\n]"

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

[
  {
    "llm_response_id": "<string>",
    "kind": "Condensation",
    "id": "<string>",
    "timestamp": "<string>",
    "source": "environment",
    "forgotten_event_ids": [
      "<string>"
    ],
    "summary": "<string>",
    "summary_offset": 1
  }
]

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

GET

/

api

/

conversations

/

{conversation_id}

/

events

Batch Get Conversation Events

curl --request GET \
  --url https://api.example.com/api/conversations/{conversation_id}/events \
  --header 'Content-Type: application/json' \
  --data '[
  "<string>"
]'

import requests

url = "https://api.example.com/api/conversations/{conversation_id}/events"

payload = ["<string>"]
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify(['<string>'])
};

fetch('https://api.example.com/api/conversations/{conversation_id}/events', 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.example.com/api/conversations/{conversation_id}/events",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "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.example.com/api/conversations/{conversation_id}/events"

	payload := strings.NewReader("[\n  \"<string>\"\n]")

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

	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.get("https://api.example.com/api/conversations/{conversation_id}/events")
  .header("Content-Type", "application/json")
  .body("[\n  \"<string>\"\n]")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/conversations/{conversation_id}/events")

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

request = Net::HTTP::Get.new(url)
request["Content-Type"] = 'application/json'
request.body = "[\n  \"<string>\"\n]"

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

[
  {
    "llm_response_id": "<string>",
    "kind": "Condensation",
    "id": "<string>",
    "timestamp": "<string>",
    "source": "environment",
    "forgotten_event_ids": [
      "<string>"
    ],
    "summary": "<string>",
    "summary_offset": 1
  }
]

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

Path Parameters

conversation_id

string<uuid>

required

Body

application/json

Response

(Condensation · object | CondensationRequest · object | CondensationSummaryEvent · object | ConversationErrorEvent · object | ConversationStateUpdateEvent · object | LLMCompletionLogEvent · object | ActionEvent · object | MessageEvent · object | AgentErrorEvent · object | ObservationEvent · object | UserRejectObservation · object | SystemPromptEvent · object | TokenEvent · object | PauseEvent · object | null)[]

Successful Response

This action indicates a condensation of the conversation history is happening.

llm_response_id

string

required

Completion or Response ID of the LLM response that generated this event

kind

string

required

Allowed value: "Condensation"

id

string

Unique event id (ULID/UUID)

timestamp

string

Event timestamp

source

enum<string>

default:environment

Available options:

agent,

user,

environment

forgotten_event_ids

string[]

The IDs of the events that are being forgotten (removed from the View given to the LLM).

summary

string | null

An optional summary of the events being forgotten.

summary_offset

integer | null

An optional offset to the start of the resulting view (after forgotten events have been removed) indicating where the summary should be inserted. If not provided, the summary will not be inserted into the view.

Required range: x >= 0