API reference

Handle retries without starting duplicate agent work.

Every initial runtime request should include an idempotency key. Reuse it only when retrying the exact same request.

Idempotency

  • Generate a fresh UUID for each new runtime task.
  • Reuse the same key only for transport retries of that same request.
  • If a stream drops after response.created, recover from the session instead of sending a new task.

HTTP errors

Errors are JSON responses shaped like { "detail": "..." } with standard HTTP codes. Common cases include 400 for invalid body, 401 for bad or missing key, and 404 for missing or inaccessible resources.

Open standard

The JSON detail bodies and standard HTTP codes described here correspond to UHP's Errors chapter, which specifies the error envelope, a closed set of codes, and which failures are worth retrying. See the UHP Errors chapter.

Create API Key

Ready to run this against a live workspace? Keys take under a minute.