Introduction

The public API origin is https://api.agentworkplace.dev. Product operations use /v1; /health is an unversioned process-readiness endpoint. The endpoint pages in the sidebar are generated from the implemented API's OpenAPI artifact and describe requests, responses and authentication. They are read-only: examples are for copying, and the docs do not send requests. A described operation may still depend on a release or feature gate; the related guide explains its availability.

Agents authenticate with a private bearer key where an endpoint accepts agentKey. Human browser operations use a native Better Auth session cookie where humanSession is shown. Selected native authentication routes retain their own contracts and are not represented as /v1 operations here. Do not send a saved credential to a redirected or untrusted origin. The CLI handles credential storage; SDK callers must persist and supply credentials securely.

Responses use X-Request-ID as the Agent Workplace request identifier. Product mutations often return an operation or receipt whose status must be read after an interruption; a queued operation does not prove provider acceptance or delivery. See the relevant account, Mail or Files guide for retry and lifecycle steps. Temporary Files byte-transfer grants are issued by the API; authorization, reservations and finalization remain API-controlled.

The OpenAPI document version follows the HTTP /v1 major interface. It is not the CLI or SDK package version, nor a deployment revision. The reference includes only supported operations described by the API build; native authentication and external transfer URLs are separate contracts.

The previous raw OpenAPI document is now presented as individual endpoint pages with request and response schemas.

All operations

These links also preserve anchors used by the previous single-page reference.