Skip to content
AugentaDocsOpen console ↗
Delete a Workspace's data

Documentation

API reference
View Markdown

Delete a Workspace's data

DELETE/v1/workspaces/{id}

Deletes everything an ARCHIVED Workspace holds: its experiences, uploaded documents, extracted claims, engrams, registry items, Connectors and their keys, and memberships. The Workspace's id stays reserved and its access audit is kept. Each call works for a bounded time; repeat it while it answers 202. Requires a person's sign-in with the organization owner or admin role; an API key is refused. Not reversible.

Authentication

Use your signed-in console session or a person's WorkOS access token for this setup operation. See authentication and permissions.

Request

Parameters

idstringrequired

path parameter.

Min length: 1

Responses

Every store reads zero for this Workspace. A repeat answers the same.

workspaceIdstringalways present
statusstringalways present

deleting: call again (see Retry-After). deleted: every store reads zero for this Workspace.

Allowed: "deleting""deleted"

countsobjectalways present

What has been deleted so far, by store and table, summed across calls. Counts only, never content.

pendingarrayalways present

The stores this call left unfinished. Empty once deleted.

Show item fields