Search Conversation Events

Search / List local events

GET /api/conversations/{conversation_id}/events/search

Search Conversation Events

cURL

curl --request GET \
  --url https://api.example.com/api/conversations/{conversation_id}/events/search

import requests

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

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

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

$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.example.com/api/conversations/{conversation_id}/events/search"

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

	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/search")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Get.new(url)

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

200

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

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

Path Parameters

conversation_id · string<uuid> · required

Query Parameters

page_id · string | null

limit · integer · default: 100

kind · string | null

source · string | null

body · string | null

sort_order · enum<string> · default: TIMESTAMP

Enum for event sorting options.

Available options: TIMESTAMP, TIMESTAMP_DESC

timestamp__gte · string<date-time> | null

timestamp__lt · string<date-time> | null

Response

200

application/json

Successful Response

items · (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)[] · required

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

Condensation

CondensationRequest

CondensationSummaryEvent

ConversationErrorEvent

ConversationStateUpdateEvent

LLMCompletionLogEvent

ActionEvent

MessageEvent

AgentErrorEvent

ObservationEvent

UserRejectObservation

SystemPromptEvent

TokenEvent

PauseEvent

Show child attributes

next_page_id · string | null