TypeScript (SDK)
import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.sandbox.loadConnectorData({
body: {},
});
console.log(result);
}
run();import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.sandbox.load_connector_data()
# Handle response
print(res)curl --request POST \
--url https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"sandboxId": "<string>",
"connectorId": 123,
"query": "<string>",
"tqlPath": "<string>",
"params": {},
"maxRows": 123,
"dataframeName": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sandboxId: '<string>',
connectorId: 123,
query: '<string>',
tqlPath: '<string>',
params: {},
maxRows: 123,
dataframeName: '<string>'
})
};
fetch('https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sandboxId' => '<string>',
'connectorId' => 123,
'query' => '<string>',
'tqlPath' => '<string>',
'params' => [
],
'maxRows' => 123,
'dataframeName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Connect-Protocol-Version: <connect-protocol-version>",
"Content-Type: application/json",
"tql_api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData"
payload := strings.NewReader("{\n \"sandboxId\": \"<string>\",\n \"connectorId\": 123,\n \"query\": \"<string>\",\n \"tqlPath\": \"<string>\",\n \"params\": {},\n \"maxRows\": 123,\n \"dataframeName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("tql_api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sandboxId\": \"<string>\",\n \"connectorId\": 123,\n \"query\": \"<string>\",\n \"tqlPath\": \"<string>\",\n \"params\": {},\n \"maxRows\": 123,\n \"dataframeName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sandboxId\": \"<string>\",\n \"connectorId\": 123,\n \"query\": \"<string>\",\n \"tqlPath\": \"<string>\",\n \"params\": {},\n \"maxRows\": 123,\n \"dataframeName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dataframeName": "<string>",
"numRows": 123,
"numCols": 123,
"preview": "<string>"
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Sandbox Exec Service
Load Connector Data
POST
/
textql.rpc.public.sandbox_exec.SandboxExecService
/
LoadConnectorData
TypeScript (SDK)
import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.sandbox.loadConnectorData({
body: {},
});
console.log(result);
}
run();import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.sandbox.load_connector_data()
# Handle response
print(res)curl --request POST \
--url https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"sandboxId": "<string>",
"connectorId": 123,
"query": "<string>",
"tqlPath": "<string>",
"params": {},
"maxRows": 123,
"dataframeName": "<string>"
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
sandboxId: '<string>',
connectorId: 123,
query: '<string>',
tqlPath: '<string>',
params: {},
maxRows: 123,
dataframeName: '<string>'
})
};
fetch('https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sandboxId' => '<string>',
'connectorId' => 123,
'query' => '<string>',
'tqlPath' => '<string>',
'params' => [
],
'maxRows' => 123,
'dataframeName' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Connect-Protocol-Version: <connect-protocol-version>",
"Content-Type: application/json",
"tql_api_key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData"
payload := strings.NewReader("{\n \"sandboxId\": \"<string>\",\n \"connectorId\": 123,\n \"query\": \"<string>\",\n \"tqlPath\": \"<string>\",\n \"params\": {},\n \"maxRows\": 123,\n \"dataframeName\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Connect-Protocol-Version", "<connect-protocol-version>")
req.Header.Add("tql_api_key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sandboxId\": \"<string>\",\n \"connectorId\": 123,\n \"query\": \"<string>\",\n \"tqlPath\": \"<string>\",\n \"params\": {},\n \"maxRows\": 123,\n \"dataframeName\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/rpc/public/textql.rpc.public.sandbox_exec.SandboxExecService/LoadConnectorData")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Connect-Protocol-Version"] = '<connect-protocol-version>'
request["tql_api_key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"sandboxId\": \"<string>\",\n \"connectorId\": 123,\n \"query\": \"<string>\",\n \"tqlPath\": \"<string>\",\n \"params\": {},\n \"maxRows\": 123,\n \"dataframeName\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"dataframeName": "<string>",
"numRows": 123,
"numCols": 123,
"preview": "<string>"
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Authorizations
Headers
Define the version of the Connect protocol
Available options:
1 Define the timeout, in ms
Body
application/json
Minimum string length:
1Struct represents a structured data value, consisting of fields
which map to dynamically typed values. In some languages, Struct
might be supported by a native representation. For example, in
scripting languages like JS a struct is represented as an
object. The details of that representation are described together
with the proto support for the language.
The JSON representation for Struct is JSON object.
Show child attributes
Show child attributes
⌘I