Skip to main content
POST
Retire a single-use benchmark workspace
Returns organization_id, parent_organization_id, reference, expires_at, retired_at and the saved outcome (nullable), containing reason, cancelled_runs and revoked_devices counts, and errors. Idempotent: an already-retired workspace returns its saved result. Scope: org:write

Authorizations

Authorization
string
header
required

Your Reason API key from Settings › API keys. New keys use reason_; legacy ara_ keys remain accepted. Keys are capability-scoped: run, mcp:read, mcp:write, secrets:read, secrets:write, sessions:read, sessions:debug, devices:read, devices:write, devices:use, computers:read, computers:write, ssh:write, knowledge:read, memory:read, memory:write, skills:read, skills:write, pages:read, pages:write, repos:read, repos:write, reviews:read, reviews:write, deployment:read, analytics:read, org:read, org:write, attachments:read, attachments:write, guardrails:read, guardrails:write, network:read, network:write, automations:read, automations:write, agent_auth:read. devices:write, devices:use, computers:read, computers:write, ssh:write, network:read and network:write are opt-in, excluded from default keys. computers:read lists visible cloud and connected computers without waking them or granting execution access. devices:read discovers local Device targets; devices:use separately consents to local execution, so a discover-and-run local workflow needs both. devices:write manages enrollment and device grants; computers:write creates or deletes cloud computers; ssh:write manages retained SSH access. network:read reads the saved workspace network policy; network:write replaces custom allowed hosts and requires a current organization owner/admin. Legacy project PATCH requests containing network_allowed_hosts also require network:write plus their existing run scope and project management permission; saved project hosts do not affect current session egress. Only owners/admins can mint or manage keys with network:write; keys cannot grant themselves more authority. See /docs/network-policies for replacement semantics and runtime applicability. mcp:write manages MCP server configuration only; it does not authorize remote MCP-tool execution. sessions:read reads sessions, including the assistant, reasoning and tool activity in their events. sessions:debug is privileged: only for organization owners/admins, it expands session events to the full diagnostic projection (diagnostic event kinds, status text and raw event metadata).

Scopes

org:write

Path Parameters

orgId
string
required

Organization id or slug. Resolve it with GET /v3/self.

workspaceId
string<uuid>
required

The single-use benchmark workspace to retire, by the organization_id that POST /v3/organizations/{orgId}/ephemeral-workspaces (REST only, not an MCP tool) returned when it was created under this workspace. Only a workspace created under the connected one can be retired; any other workspace, this one included, returns 404.

Response

Retired (or already retired).

organization_id
string<uuid>
required

Id of the ephemeral workspace.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
parent_organization_id
string<uuid>
required

Id of the workspace that created it and pays for it.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
reference
string
required

The caller's trial identifier given at creation.

expires_at
string
required

When the workspace is retired automatically.

retired_at
string
required

When it was retired; always set, also when it was already retired before this call.

outcome
object | null
required

What retirement did, saved when it ran; null if no outcome was saved.