Skip to navigation

Attach to a sandbox

View as Markdown

Idempotent. Creates, resumes, relaunches, or reuses, and returns a usable handle either way. A sandbox still being prepared answers 202 with Retry-After and no endpoint; call again after it.

Authentication

AuthorizationBearer
The deployment's token, or the dev session's token for an agent running locally.

Path parameters

namestringRequired

Caller-supplied sandbox name, usually a conversation ID

Request

This endpoint expects an object.
classstringOptional

Response

OK
classstringOptional
endpointstringOptional
expires_atstringOptional
headersmap from strings to stringsOptional
namestringOptional
statestringOptional

Errors

400
Bad Request Error
402
Payment Required Error
409
Conflict Error
502
Bad Gateway Error
503
Service Unavailable Error