Skip to navigation
API ReferenceSpaces

Get a Space

View as Markdown
Get one complete space, including its environment.

Authentication

AuthorizationBearer

Use Bearer <api-key>.

Path parameters

spaceIdstringRequired

Headers

BCTRL-VersionenumOptional
Dated API version. Defaults to the release pinned when the API key was created.
Allowed values:
BCTRL-SpacestringOptional
Select one authorized Space by its opaque ID or unique name. Omission uses the operation default.
BCTRL-Subaccount-IdstringOptional
Optional effective subaccount context for organization API keys. Subaccount API keys are already scoped and cannot use this header to act as another subaccount.

Response headers

BCTRL-Request-IdstringOptional
Current request identifier, also echoed in errors.
BCTRL-VersionstringOptional
Negotiated dated API version.
RateLimit-Limitinteger

Evaluated policy limit; zero when no finite policy was evaluated.

RateLimit-Remaininginteger

Remaining policy budget; zero when no finite policy was evaluated.

RateLimit-Resetinteger

Seconds until reset; zero when no finite policy was evaluated.

Response

OK
capabilityScopeslist of strings
createdAtdatetime
RFC 3339 timestamp with a UTC offset.
deletionErrorstring or null

Why the deletion is not finished yet; it is retried. Null otherwise.

environmentobject
expireAfterIdleDaysinteger1-365
idstring
Unique space identifier generated by BCTRL.
isDefaultboolean
namestring1-200 characters

Customer-facing resource name. 1–200 characters.

object"space"
regionenum
Allowed values:
statusenum

deleting once DELETE is accepted: its browsers, sandboxes, agents, Tasks, Conversations, files and views are being stopped and removed. deleted appears only in the DELETE response when the deletion finished within wait; the Space is then gone.

Allowed values:
updatedAtdatetime
RFC 3339 timestamp with a UTC offset.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error