Skip to main content
POST
/
v1
/
sandbox
/
start
StartSandbox
curl --request POST \
  --url https://app.textql.com/v1/sandbox/start \
  --header 'Authorization: Bearer <token>' \
  --header 'Connect-Protocol-Version: <connect-protocol-version>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "sandboxId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.textql.com/llms.txt

Use this file to discover all available pages before exploring further.

v2 available: See POST /v2/sandboxes for the REST-native version of this endpoint.

Authorizations

​
Authorization
string
header
required

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

Headers

​
Connect-Protocol-Version
enum<number>
required

Define the version of the Connect protocol

Available options:
1
​
Connect-Timeout-Ms
number

Define the timeout, in ms

Body

application/json
​
name
string | null

Optional human-readable name for the sandbox

Response

Success

​
sandboxId
string
​
createdAt
string<date-time>

A Timestamp represents a point in time independent of any time zone or local calendar, encoded as a count of seconds and fractions of seconds at nanosecond resolution. In JSON format, the Timestamp type is encoded as a string in the RFC 3339 format.

Examples:

"2023-01-15T01:30:15.01Z"

"2024-12-25T12:00:00Z"