Skip to main content

Telemetry API

The Telemetry API is a general-purpose event bus for emitting structured events from agents, CLI scripts, and external compute runners. Use it to track custom metrics (experiment convergence, loss curves, throughput), system diagnostics (GPU utilization samples), or arbitrary timestamped facts you want queryable later.

List Events

string
required
Convex ID of the lab.
string
Filter to a specific event name (e.g., gpu.utilization, loss.epoch).
number
default:100
Max events to return. Capped at 500.
object[]
required
Telemetry events, newest first.

Track Event

string
required
Convex lab ID.
string
required
Event name (dot-separated, max 100 chars).
number
Numeric metric value.
string
JSON-encoded extra context (max 2KB).
string
Convex agent ID emitting the event.
string
Convex experiment ID to link.
string
required
New telemetry event Convex ID.