Skip to main content
Agent Server defaults to http://localhost:8124. Business resources use the versioned /v1 prefix. Requests and responses are JSON, errors are application/problem+json, and run events use SSE.

Conventions

  • Timestamps are timezone-aware ISO 8601 UTC.
  • IDs are opaque strings; do not parse their format.
  • Unknown request fields are rejected.
  • Assistant/Thread/Schedule creation returns 201; Run creation/resume returns 202.
  • Successful deletion returns 204.
  • Business failure is represented by run.status and run.error, not replaced by an HTTP status.
  • Automated run-creation retries must send a stable Idempotency-Key.

Complete endpoint list

Run lifecycle

Stable status values are pending, running, paused, succeeded, failed, cancelling, cancelled, timed_out, and dead_letter.

Authentication and RBAC

Bearer tokens, development API keys, and roles.

Errors and SSE

Stable error codes, resume, and deduplication.