/

Docs
History
Schema
Generate

Filter operations

Account1

agents1

api_keys6

Arena8

artifacts60

branding3

browser_profiles6

catalog25

channels31

Channels2

connectors17

Credit campaigns4

Desktop23

get/desktop/machines/{id}/automationRead persistent Mac authorization [admin]
delete/desktop/machines/{id}/automationDisable persistent Mac authorization [admin]
patch/desktop/machines/{id}/automationConfigure persistent Mac authorization [admin]
get/desktop/mounts/{mount}/toolsRead authorized Mac host/device or browser download controls [read]
post/desktop/mounts/{mount}/tools/{tool}Operate an authorized Mac host/device control [write]
post/desktop/machines/{id}/administration/device_configure_app_accessConfigure Mac app data access [admin]
post/desktop/machines/{id}/administration/device_configure_blocked_folderConfigure a custom blocked folder [admin]
post/desktop/machines/{id}/administration/device_configure_screen_reachConfigure Mac screen reach [admin]
post/desktop/machines/{id}/administration/device_forget_screen_appRevoke a remembered screen-app decision [admin]
post/desktop/machines/{id}/administration/device_forget_chrome_siteRevoke a remembered Chrome-site decision [admin]
post/desktop/machines/{id}/administration/device_configure_setup_filesConfigure local setup Files consent [admin]
post/desktop/machines/{id}/administration/device_auth_stateRead native Mac sign-in state [admin]
post/desktop/machines/{id}/administration/device_cancel_sign_inCancel native Mac sign-in [admin]
post/desktop/machines/{id}/administration/device_sign_outRequest native Mac sign-out [admin]
post/desktop/machines/{id}/administration/device_available_plansRead available local subscription providers [admin]
post/desktop/machines/{id}/administration/device_cancel_plan_sign_inCancel local subscription sign-in [admin]
post/desktop/machines/{id}/administration/device_capture_arena_chartExport a complete Mac Result or capture a rectangle [admin]
post/desktop/machines/{id}/administration/device_save_arena_chartSave an Arena chart PNG [admin]
post/desktop/machines/{id}/administration/device_configure_local_syncConfigure global local-session sync [admin]
post/desktop/machines/{id}/administration/device_relaunchRequest native Mac relaunch [admin]
post/desktop/machines/{id}/administration/device_restart_to_updateRequest restart to install a downloaded update [admin]
post/desktop/machines/{id}/administration/legacy_drafts_listList legacy unsent Mac drafts [admin]
post/desktop/machines/{id}/administration/legacy_drafts_adoptAdopt an explicitly selected legacy draft [admin]

environments11

Events4

files9

Gateway1

harnesses13

help1

Memory4

notifications5

oauth_clients6

oauth_grants2

partner8

sessions10

tasks15

Tasks2

trace-library4

traces5

universes1

vaults10

worker-pools7

workspace-connectors9

workspace-describe1

workspace-identity3

get/billingRead credit balance and card availability [read]
post/billing/card-setupStart saving a payment card [write]
get/billing/auto-topupRead auto top-up settings [read]
patch/billing/auto-topupChange auto top-up settings [write]
post/billing/topupsBuy credit for your own balance with your saved card [write]
post/billing/credit-invites/claimClaim a credit invite link for your own balance [write]
get/billing/usageAccount-wide usage across sessions and API keys [read]
get/billing/usage/exportDownload every usage record in a range as CSV or JSONL [read]
get/billing/usage/requestsPer-request history of your developer API keys [read]
get/billing/coding-planRead your coding plan [read]
post/billing/coding-planJoin the coding plan, or change your monthly amount [write]
delete/billing/coding-planStop your coding plan renewing [write]
get/billing/referral-linksYour customer discount links and what they earned [read]
post/billing/referral-linksCreate a customer discount link [write]
post/billing/referral-links/{id}/disableDisable one of your customer discount links [write]
get/meeting-recordingsList the caller's meeting recordings [read]
post/meeting-recordingsReport a finished meeting recording for metering [write]
get/meeting-recordings/{id}Get one meeting recording [read]
get/preferencesThe caller's platform preferences [read]
patch/preferencesUpdate the caller's platform preferences [write]
post/runsRun a product [write]
get/runs/{id}Read a Run [read]
get/runs/{id}/eventsRead durable Run events, or observe with Accept: text/event-stream [read]
post/runs/{id}/eventsTarget steering or an interrupt to this Run [write]
get/whoamiCaller identity, resolved universe, effective scopes [read]
get/universesList universes [read]
post/universesCreate a universe [write, personal tokens only]
get/universes/{slug}Universe detail [read]
delete/universes/{slug}Permanently delete a workspace and everything in it [write, owner]
patch/universes/{slug}Rename a workspace or enable Google Limited Use [write, owner]
get/universes/{slug}/deletionWhat deleting the workspace would remove, and whether it can be deleted [read, owner]
get/universes/{slug}/membersPeople in the workspace and, for owners and admins, waiting invitations [read]
delete/universes/{slug}/members/{userId}Remove a non-owner from the workspace, or leave it [write]
patch/universes/{slug}/members/{userId}Make someone an admin or a member [write, owner]
get/universes/{slug}/agentsThe agents this workspace chose from the catalog [read]
get/universes/{slug}/agents/{handle}One agent the workspace chose from the catalog [read]
put/universes/{slug}/agents/{handle}Install an agent from the catalog, or change its default model or enabled state [write, owner or admin]
delete/universes/{slug}/agents/{handle}Remove an agent from the workspace's choices [write, owner or admin]
post/universes/{slug}/invitesAdd people to the workspace by email [write, owner or admin]
get/invites/{token}What an invitation link offers the signed-in person [read]
post/invites/{token}Join the workspace through an invitation link [write]
get/invites/{token}/publicPublic preview of an invitation — workspace name and inviter, no auth required
delete/universes/{slug}/invites/{inviteId}Withdraw an invitation that has not been taken up [write, owner or admin]
get/universes/{slug}/walletA workspace's own wallet: balance, each member's spending this month, limits, members waiting for a higher limit [read, owner or admin]
post/universes/{slug}/walletGive the workspace a wallet of its own [write, owner or admin]
post/universes/{slug}/wallet/transfersMove some of your own purchased credit into the workspace wallet [write, owner or admin]
post/universes/{slug}/wallet/topupsBuy credit for the workspace wallet with your own saved card [write, owner or admin]
post/universes/{slug}/wallet/limit-requests/{requestId}Answer a member's request for a higher monthly limit [write, owner or admin]
put/universes/{slug}/wallet/limits/{userId}Set or clear a member's monthly limit on workspace wallet spending [write, owner or admin]
get/universes/{slug}/connectionsDeprecated: use GET /plugins?view=yours&source=app. Connected apps people share with the workspace, and the ones it owns [read]
post/universes/{slug}/connectionsShare one of your own connections with the workspace, or start connecting an app for it [write]
post/universes/{slug}/connections/completeRecord an app connected for the workspace itself [write, owner or admin]
delete/universes/{slug}/connections/{connectionId}Deprecated: use DELETE /plugins/app:{app}/share?workspace={slug}&connection_id={connectionId}. Stop sharing a connection with the workspace [write, the sharer, owner or admin]
get/shared-connectionsDeprecated: use GET /plugins?view=yours&source=app&include=shared. Everything you share with a workspace, and the calls made through each [read]
get/universes/{slug}/keysKeys that belong to the workspace [read, owner or admin]
post/universes/{slug}/keysMake a workspace key [admin, owner or admin]
delete/universes/{slug}/keys/{keyId}Revoke a workspace key [admin, owner or admin]
get/universes/{slug}/hooksGet workspace shared hooks [read]
put/universes/{slug}/hooksReplace workspace shared hooks (owner only) [write]
get/universes/{slug}/policiesList workspace policy rules [read]
post/universes/{slug}/policiesCreate a workspace policy rule (owner only) [write]
get/universes/{slug}/policies/{ruleId}Get a workspace policy rule [read]
delete/universes/{slug}/policies/{ruleId}Delete a workspace policy rule (owner only) [write]
patch/universes/{slug}/policies/{ruleId}Update a workspace policy rule (owner only) [write]
get/agentsList agents in the resolved universe [read]
post/agentsCreate an agent [write]
get/agents/{id}Agent detail [read]
delete/agents/{id}Delete the agent — only with zero live sessions (409 agent_has_sessions) [admin]
patch/agents/{id}Update displayName / capabilities / metadata [write]
post/agents/{id}/archiveArchive the agent — read-only, sessions keep running, new sessions rejected [admin]
post/agents/{id}/inviteInvite the agent into a team chat: with conversation_id it joins that conversation's roster (RFC-0151); without, returns the Slack install URL [write]
put/agents/{id}/promptSave the user prompt layer; applies to sessions started after the save [write]
get/agents/{id}/prompt/versionsPrompt version history [read]
get/agents/{id}/secretsDeclared secret keys + set/unset — never values [read]
put/agents/{id}/secrets/{key}Set a declared secret's value (write-only) [write]
delete/agents/{id}/secrets/{key}Unset a secret [write]
put/agents/{id}/avatarUpload a custom PNG/JPEG avatar for the agent (≤ 1 MB) [write]
delete/agents/{id}/avatarRemove the custom avatar and revert to the engine-mark / sky-avatar fallback [write]
get/external_accountsList the workspace's accounts at outside vendors — never credentials [read]
post/external_accountsConnect a vendor account, or replace the credential of the one with the same vendor and label [write]
delete/external_accounts/{id}Disconnect an account; a later task that needs it asks for it again [write]
get/external_accounts/{id}/usageWhich agents and tasks ran on a vendor account [read]
get/model-subscriptionsList connected model subscriptions — metadata only, never credentials [read]
post/model-subscriptionsAdd a separate subscription account [write]
put/model-subscriptions/{provider}Connect or replace a subscription credential (write-only) [write]
delete/model-subscriptions/{provider}Disconnect — affected agents keep their pointer and fail until reconnected or switched [write]
patch/model-subscriptions/{provider}Update useForNewAgents / label [write]
post/model-subscriptions/{provider}/loginsStart a browser sign-in to a model plan [write]
get/model-subscriptions/{provider}/logins/{loginId}Advance a browser sign-in; stores the subscription when it finishes [write]
delete/model-subscriptions/{provider}/logins/{loginId}Abandon a browser sign-in and free its sandbox [write]
post/model-subscriptions/{provider}/logins/{loginId}/codeSubmit the code the provider's sign-in page shows [write]
get/model-subscriptions/{provider}/usagePlan allowance left on a connected account [read]
post/model-subscriptions/{provider}/switch-to-creditsMove the agents on a subscription account onto platform credits [write]
get/capabilitiesDeprecated: use GET /plugins?view=yours. Everything your agents can use, in one list [read]
get/pluginsEverything agents can use, as one Plugin list; or the installed plugin bundles [read]
post/pluginsInstall a plugin bundle, add a custom MCP server, or upload a skill [write]
get/plugins/{name}One plugin by id [read]
delete/plugins/{name}Remove a plugin or disconnect it [write]
patch/plugins/{name}Switch an installed plugin on or off [write]
post/plugins/{name}/addAdd a plugin or connect it [write]

Desktop

Changes to Read native Mac sign-in state [admin]

post/desktop/machines/{id}/administration/device_auth_state

Nov 2, 2026e5e8f0229a99 Revision changes
- info
  endpoint added