Traceway
API Reference

Events

REST API for the Server-Sent Events stream and event types.

SSE endpoint

GET /api/events

Opens a Server-Sent Events connection. The server pushes events as they happen.

Authentication

ModeMethod
LocalNo auth required
Cloud?token=<jwt_or_api_key> query parameter

Example

curl -N "https://api.traceway.ai/api/events?token=tw_sk_..." \
  -H "Accept: text/event-stream"

Each event is formatted as:

id: 42
event: message
data: {"type":"span_completed","span":{...}}

Reconnection

Pass Last-Event-ID header or ?since=<sequence> query parameter to replay missed events:

curl -N "https://api.traceway.ai/api/events?token=tw_sk_...&since=42" \
  -H "Accept: text/event-stream"

All events with sequence > 42 are replayed, then the stream continues with live events.

Event types

Spans

TypePayload
span_created{ span: Span }
span_completed{ span: Span }
span_failed{ span: Span }
span_deleted{ span_id: string }

Traces

TypePayload
trace_created{ trace: Trace }
trace_deleted{ trace_id: string }

Datasets

TypePayload
dataset_created{ dataset: Dataset }
dataset_deleted{ dataset_id: string }
datapoint_created{ datapoint: Datapoint }

Queue

TypePayload
queue_item_updated{ item: QueueItem }

Evaluations

TypePayload
eval_started{ run_id, dataset_id }
eval_progress{ run_id, progress, total }
eval_completed{ run_id }
eval_failed{ run_id, error }
eval_cancelled{ run_id }

Capture rules

TypePayload
capture_triggered{ rule_id, span_id, datapoint_id }

Other

TypePayload
cleared{}

On this page