curl --request GET \
--url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream', 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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream",
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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream"
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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream")
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>",
"org_id": "<string>",
"project_id": "<string>",
"agent_id": "<string>",
"turn_id": "<string>",
"turn_sequence": 4503599627370496,
"is_opening_event": true,
"sequence": 4503599627370496,
"event_kind": "agent_input",
"agent_input_id": "<string>",
"input_kind": "content",
"content_blocks": [
{
"type": "text",
"text": "<string>",
"metadata": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"actor_id": "<string>",
"input_idempotency_key": "<string>",
"control_type": "cancel_current",
"interaction_id": "<string>",
"agent_config_id": "<string>"
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Stream events
curl --request GET \
--url https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream', 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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream",
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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream"
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.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.omnara.com/v1/orgs/{orgID}/projects/{projectID}/agents/{agentID}/events/stream")
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>",
"org_id": "<string>",
"project_id": "<string>",
"agent_id": "<string>",
"turn_id": "<string>",
"turn_sequence": 4503599627370496,
"is_opening_event": true,
"sequence": 4503599627370496,
"event_kind": "agent_input",
"agent_input_id": "<string>",
"input_kind": "content",
"content_blocks": [
{
"type": "text",
"text": "<string>",
"metadata": {}
}
],
"created_at": "2023-11-07T05:31:56Z",
"actor_id": "<string>",
"input_idempotency_key": "<string>",
"control_type": "cancel_current",
"interaction_id": "<string>",
"agent_config_id": "<string>"
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>",
"current_digest": "<string>",
"issues": [
{
"path": "<string>",
"message": "<string>",
"line": 2,
"column": 2
}
]
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
An opaque Omnara personal or organization bearer token.
Headers
x >= 0Path Parameters
^org_[a-z2-7]{26}$^proj_[a-z2-7]{26}$^agt_[a-z2-7]{26}$Query Parameters
x >= 0Opt in to ephemeral delta streamed frames while a model call is in flight. This includes partial assistant text, tool call, and reasoning output. Each frame carries the public turn_id and model_call_context_id it belongs to, and tool_use block starts carry the same public tool_call_id the durable model_output content block and tool_result event will use. Deltas are best-effort: they are not persisted and are not replayed on reconnect. The durable model_output event remains the source of truth. Default false.
Response
Server-sent event stream. Durable frames use agent_input, model_output, tool_result, or context_checkpoint as the SSE event name and set the SSE id field to the event's sequence, which reconnects can replay via Last-Event-ID. Best-effort tool lifecycle updates use tool_call_update and cover this agent and every subagent beneath it, model previews use model_output_delta, and stream-closing errors use error; none carries an SSE id, so reconnects resume from the last durable event. The response closes after every error frame. Raw clients reconnect when the error's stable code is service_unavailable and treat other current codes as terminal. Heartbeats are SSE comments and carry no JSON payload.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
One JSON payload from the event stream: an authoritative durable event, a best-effort tool-call update, a best-effort model-output preview, or a stream-closing error. The wire response ends after an error payload; service_unavailable is retryable and other current codes are terminal.
^evt_[a-z2-7]{26}$^org_[a-z2-7]{26}$^proj_[a-z2-7]{26}$^agt_[a-z2-7]{26}$^trn_[a-z2-7]{26}$Positive per-agent event, turn, or live-frame sequence.
1 <= x <= 9007199254740991Positive per-agent event, turn, or live-frame sequence.
1 <= x <= 9007199254740991agent_input Matches the input that produced this event, allowing clients to correlate an input submission with its durable timeline admission.
^ain_[a-z2-7]{26}$content, control, interaction_response, config_change - Option 1
- Option 2
Show child attributes
Show child attributes
Actor attributed to the input. Resolve details through the project actors endpoints.
^actr_[a-z2-7]{26}$Echoes the Idempotency-Key of a content-input request so its sender can recognize the durable admission. Absent for other input kinds.
cancel_current Interaction answered by an interaction_response input.
^int_[a-z2-7]{26}$Configuration selected by a config_change input.
^acfg_[a-z2-7]{26}$