Sessions
Stream session status
Opens a Server-Sent Events (SSE) stream for a session. The stream sends
a status event immediately after connecting and whenever the session
status changes. Each event’s data field contains a session snapshot
with messages: null.
While the session remains running or follow_up_running, the server
sends a : keepalive comment every 15 seconds when no status change
occurs. SSE clients ignore comments automatically.
The stream closes after sending an idle, failed, or cancelled
status. After receiving a terminal status, retrieve the final
conversation with GET /v1/sessions/{session_id}.
If the connection closes before a terminal status arrives, reconnect
to this endpoint. The first event always reports the current status, so
clients do not need an event cursor or Last-Event-ID header.
GET
/
v1
/
sessions
/
{session_id}
/
events
Stream session status
curl --request GET \
--url https://api.traversal.com/v1/sessions/{session_id}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.traversal.com/v1/sessions/{session_id}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.traversal.com/v1/sessions/{session_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.traversal.com/v1/sessions/{session_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_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.traversal.com/v1/sessions/{session_id}/events"
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))
}HttpResponse<String> response = Unirest.get("https://api.traversal.com/v1/sessions/{session_id}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.traversal.com/v1/sessions/{session_id}/events")
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_bodyevent: status
data: {"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"running","title":"Elevated error rate in checkout service","input":"Our checkout service started returning 500 errors.","created_at":"2026-08-10T14:35:00Z","updated_at":"2026-08-10T14:35:00Z","messages":null}
: keepalive
event: status
data: {"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"idle","title":"Elevated error rate in checkout service","input":"Our checkout service started returning 500 errors.","created_at":"2026-08-10T14:35:00Z","updated_at":"2026-08-10T14:38:12Z","messages":null}
{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}Authorizations
Bearer token in the Authorization header — for example,
Authorization: Bearer YOUR_API_KEY. Personal keys act as their owner;
the Sessions API also accepts organization-owned service-account keys.
Knowledge Files endpoints currently require a personal key.
Path Parameters
The unique identifier of the session.
Response
Session status event stream.
The response is of type string.
⌘I
Stream session status
curl --request GET \
--url https://api.traversal.com/v1/sessions/{session_id}/events \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.traversal.com/v1/sessions/{session_id}/events"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.traversal.com/v1/sessions/{session_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.traversal.com/v1/sessions/{session_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_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.traversal.com/v1/sessions/{session_id}/events"
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))
}HttpResponse<String> response = Unirest.get("https://api.traversal.com/v1/sessions/{session_id}/events")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.traversal.com/v1/sessions/{session_id}/events")
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_bodyevent: status
data: {"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"running","title":"Elevated error rate in checkout service","input":"Our checkout service started returning 500 errors.","created_at":"2026-08-10T14:35:00Z","updated_at":"2026-08-10T14:35:00Z","messages":null}
: keepalive
event: status
data: {"id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","status":"idle","title":"Elevated error rate in checkout service","input":"Our checkout service started returning 500 errors.","created_at":"2026-08-10T14:35:00Z","updated_at":"2026-08-10T14:38:12Z","messages":null}
{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}{
"error": {
"code": "conflict",
"message": "<string>",
"retry_after": 123
}
}