Skip to main content
POST
/
v2
/
sandboxes
/
{id}
/
query
Load Connector Data
curl --request POST \
  --url https://app.textql.com/v2/sandboxes/{id}/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connector_id": 123,
  "query": "<string>",
  "dataframe_name": "<string>"
}
'
{
  "preview": [
    [
      "<string>"
    ]
  ],
  "dataframe_name": "<string>",
  "num_rows": 123,
  "num_cols": 123
}

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.

Authorizations

​
Authorization
string
header
required

API key or JWT token

Path Parameters

​
id
string
required

Sandbox ID

Body

application/json
​
connector_id
integer<int32>
required

Connector to query

​
query
string
required

SQL query to execute

​
dataframe_name
string

Name for the resulting dataframe (defaults to connector_{id})

Response

Query result loaded into dataframe

​
preview
string[][]

Preview rows of the query result

​
dataframe_name
string
​
num_rows
integer<int64>
​
num_cols
integer<int64>