Search Events

Search through the event stream with filtering and pagination.

GET /api/conversations/{conversation_id}/events

Search Events

cURL

curl --request GET \
  --url https://app.all-hands.dev/api/conversations/{conversation_id}/events \
  --header 'Content-Type: application/json' \
  --header 'X-Session-API-Key: <api-key>' \
  --data '
{
  "exclude_hidden": false,
  "query": "<string>",
  "include_types": [
    "<unknown>"
  ],
  "exclude_types": [
    "<unknown>"
  ],
  "source": "<string>",
  "start_date": "<string>",
  "end_date": "<string>"
}
'

import requests

url = "https://app.all-hands.dev/api/conversations/{conversation_id}/events"

payload = {
    "exclude_hidden": False,
    "query": "<string>",
    "include_types": ["<unknown>"],
    "exclude_types": ["<unknown>"],
    "source": "<string>",
    "start_date": "<string>",
    "end_date": "<string>"
}
headers = {
    "X-Session-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-Session-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    exclude_hidden: false,
    query: '<string>',
    include_types: ['<unknown>'],
    exclude_types: ['<unknown>'],
    source: '<string>',
    start_date: '<string>',
    end_date: '<string>'
  })
};

fetch('https://app.all-hands.dev/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://app.all-hands.dev/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([
    'exclude_hidden' => false,
    'query' => '<string>',
    'include_types' => [
        '<unknown>'
    ],
    'exclude_types' => [
        '<unknown>'
    ],
    'source' => '<string>',
    'start_date' => '<string>',
    'end_date' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Session-API-Key: <api-key>"
  ],
]);

$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://app.all-hands.dev/api/conversations/{conversation_id}/events"

	payload := strings.NewReader("{\n  \"exclude_hidden\": false,\n  \"query\": \"<string>\",\n  \"include_types\": [\n    \"<unknown>\"\n  ],\n  \"exclude_types\": [\n    \"<unknown>\"\n  ],\n  \"source\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\"\n}")

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

	req.Header.Add("X-Session-API-Key", "<api-key>")
	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://app.all-hands.dev/api/conversations/{conversation_id}/events")
  .header("X-Session-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"exclude_hidden\": false,\n  \"query\": \"<string>\",\n  \"include_types\": [\n    \"<unknown>\"\n  ],\n  \"exclude_types\": [\n    \"<unknown>\"\n  ],\n  \"source\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.all-hands.dev/api/conversations/{conversation_id}/events")

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

request = Net::HTTP::Get.new(url)
request["X-Session-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"exclude_hidden\": false,\n  \"query\": \"<string>\",\n  \"include_types\": [\n    \"<unknown>\"\n  ],\n  \"exclude_types\": [\n    \"<unknown>\"\n  ],\n  \"source\": \"<string>\",\n  \"start_date\": \"<string>\",\n  \"end_date\": \"<string>\"\n}"

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

422

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

Authorizations

X-Session-API-Key · string · header · required

Path Parameters

conversation_id · string · required

Query Parameters

start_id · integer · default: 0

end_id · integer | null

reverse · boolean · default: false

limit · integer · default: 20

Body

application/json

exclude_hidden · boolean · default: false

query · string | null

include_types · any[] | null

exclude_types · any[] | null

source · string | null

start_date · string | null

end_date · string | null

Response

200

application/json

Successful Response