API overview

View as Markdown

The API separates lifecycle resources from callable capabilities:

  • /v1/runtimes owns runtime lifecycle only.
  • /v1/tools describes and calls built-in or custom Tools.
  • /v1/tool-calls exposes durable status, results, cancellation, and input.
  • /v1/conversations manages messages, turns, cancellation, and streaming.
  • /v1/runs exposes trace spans, events, files, and one combined stream.
  • /v1/views creates expiring browser-safe embeds.

Resource IDs are short opaque typed identifiers such as rt_…, run_…, call_…, and conv_…. Treat them as strings and never derive one from another.