Skip to main content
GET
Fetch a workspace

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string<uuid>
required

Deprecated container id: a legacy workspace id OR a chat-session id (the session-container form is what v2 returns for new agents). Both resolve everywhere this parameter appears.

Response

The workspace object.

object
string
required
Allowed value: "workspace"
id
string<uuid>
required
name
string
required
createdByApi
boolean
required

True when the container was created through the API (session containers and legacy API-created workspaces).

url
string<uri>
required

Deep link a human can open.

createdAt
string<date-time>
required