TypeScript (SDK)
import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.settings.get({
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.settings.get(body={})
# Handle response
print(res)curl --request POST \
--url https://app.textql.com/rpc/public/textql.rpc.public.settings.SettingsService/GetOrganizationSettings \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '{}'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://app.textql.com/rpc/public/textql.rpc.public.settings.SettingsService/GetOrganizationSettings', 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.settings.SettingsService/GetOrganizationSettings",
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([
]),
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.settings.SettingsService/GetOrganizationSettings"
payload := strings.NewReader("{}")
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.settings.SettingsService/GetOrganizationSettings")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/rpc/public/textql.rpc.public.settings.SettingsService/GetOrganizationSettings")
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 = "{}"
response = http.request(request)
puts response.read_body{
"organization": {
"orgId": "<string>",
"slackTeamId": "<string>",
"slackKey": "<string>",
"defaultConnectorId": 123,
"limitDataVisibility": true,
"requireAttached": true,
"organizationName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationLogoUrl": "<string>",
"emailAllowedDomains": [
"<string>"
],
"allowedAuthMethods": [
"<string>"
],
"theme": {
"bg": "<string>",
"headerBg": "<string>",
"cardBg": "<string>",
"primaryAccent": "<string>",
"cardAccent": "<string>",
"heading": "<string>",
"text": "<string>",
"cardHeading": "<string>",
"cardText": "<string>",
"logoUrl": "<string>",
"docsUrl": "<string>"
},
"orgMeta": "<string>",
"injectWholeOntologyDisableSearch": true,
"warning": "<string>",
"publicPreview": true,
"chatV5Cutover": true,
"secretsEnabled": true,
"emailPollingEnabled": true,
"logoUrl": "<string>",
"brandName": "<string>",
"paradigmParams": {
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"pythonEnabled": true,
"powerbiEnabled": true,
"googleDriveEnabled": true,
"formEditorEnabled": true,
"tableauEnabled": true,
"fileUploadEnabled": true,
"multipleConnectorMode": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"modelSwitchingEnabled": true,
"feedExplorerEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"parallelToolsEnabled": true,
"emailOutputEnabled": true,
"questionsToolEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"datasetId": "<string>"
},
"defaultLlmModel": 123,
"preferredProvider": "<string>",
"systemDefaultModel": 123,
"toolRestrictions": {
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"pythonEnabled": true,
"powerbiEnabled": true,
"googleDriveEnabled": true,
"formEditorEnabled": true,
"tableauEnabled": true,
"fileUploadEnabled": true,
"multipleConnectorMode": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"modelSwitchingEnabled": true,
"feedExplorerEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"parallelToolsEnabled": true,
"emailOutputEnabled": true,
"questionsToolEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"datasetId": "<string>"
},
"consoleAccess": true,
"defaultConnectorIds": [
123
],
"hideToolCells": true,
"disableEmojis": true,
"hideExampleConnectors": true,
"trainingMode": true,
"dashboardsEnabled": true,
"billingAdminId": "<string>",
"methodologyEnabled": true,
"allowAllApiAccess": true,
"feedEnabled": true,
"contextV3Enabled": true,
"bashEnabled": true,
"defaultRoutingEnabled": true,
"enabledModelIds": [
123
],
"restrictedModelIds": [
123
],
"restrictedFamilies": [
"<string>"
],
"discoverable": true,
"observabilityEnabled": true,
"notificationsEnabled": true,
"clientDbOverrideEnabled": true,
"contextReviewRequired": true,
"googleConnectorEnabled": true,
"hideApiConnectors": true,
"fastModeEnabled": true,
"maxThinkingEnabled": true,
"sandboxStateRetentionDays": 123,
"sandboxLeaseConfigEnabled": true,
"deleteInactiveThreadsEnabled": true,
"threadRetentionDays": 123,
"threadHardDeleteGraceDays": 123,
"emailOutputEnabled": true,
"defaultPlaybookPrivate": true,
"defaultDashboardOutput": true,
"defaultMethodology": 123,
"scimNewGroupDefaultRoleType": "<string>",
"groupsFeatureEnabled": true,
"availableProviders": [
"<string>"
],
"showTextqlUsage": true,
"tracesEnabled": true,
"allowLlmDataRetention": true,
"soxDbSessionMetadataEnabled": true,
"smsEnabled": true,
"scimAssignDefaultRole": true,
"migrationBannerDismissed": true,
"configMigrationsEnabled": true,
"sandboxObservabilityEnabled": true,
"dataAppsEnabled": true,
"issuesEnabled": true,
"configObjectsEnabled": true,
"configObjectsPlaybooksEnabled": true,
"configObjectsDashboardsEnabled": true,
"configAutofixEnabled": true,
"helmChartVersion": "<string>",
"spendTransparencyEnabled": true,
"sharingDisabled": true,
"appWritebackAutoApproveEnabled": true
}
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Settings Service
Get Organization Settings
POST
/
textql.rpc.public.settings.SettingsService
/
GetOrganizationSettings
TypeScript (SDK)
import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.settings.get({
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.settings.get(body={})
# Handle response
print(res)curl --request POST \
--url https://app.textql.com/rpc/public/textql.rpc.public.settings.SettingsService/GetOrganizationSettings \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '{}'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({})
};
fetch('https://app.textql.com/rpc/public/textql.rpc.public.settings.SettingsService/GetOrganizationSettings', 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.settings.SettingsService/GetOrganizationSettings",
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([
]),
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.settings.SettingsService/GetOrganizationSettings"
payload := strings.NewReader("{}")
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.settings.SettingsService/GetOrganizationSettings")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/rpc/public/textql.rpc.public.settings.SettingsService/GetOrganizationSettings")
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 = "{}"
response = http.request(request)
puts response.read_body{
"organization": {
"orgId": "<string>",
"slackTeamId": "<string>",
"slackKey": "<string>",
"defaultConnectorId": 123,
"limitDataVisibility": true,
"requireAttached": true,
"organizationName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"organizationLogoUrl": "<string>",
"emailAllowedDomains": [
"<string>"
],
"allowedAuthMethods": [
"<string>"
],
"theme": {
"bg": "<string>",
"headerBg": "<string>",
"cardBg": "<string>",
"primaryAccent": "<string>",
"cardAccent": "<string>",
"heading": "<string>",
"text": "<string>",
"cardHeading": "<string>",
"cardText": "<string>",
"logoUrl": "<string>",
"docsUrl": "<string>"
},
"orgMeta": "<string>",
"injectWholeOntologyDisableSearch": true,
"warning": "<string>",
"publicPreview": true,
"chatV5Cutover": true,
"secretsEnabled": true,
"emailPollingEnabled": true,
"logoUrl": "<string>",
"brandName": "<string>",
"paradigmParams": {
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"pythonEnabled": true,
"powerbiEnabled": true,
"googleDriveEnabled": true,
"formEditorEnabled": true,
"tableauEnabled": true,
"fileUploadEnabled": true,
"multipleConnectorMode": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"modelSwitchingEnabled": true,
"feedExplorerEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"parallelToolsEnabled": true,
"emailOutputEnabled": true,
"questionsToolEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"datasetId": "<string>"
},
"defaultLlmModel": 123,
"preferredProvider": "<string>",
"systemDefaultModel": 123,
"toolRestrictions": {
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"pythonEnabled": true,
"powerbiEnabled": true,
"googleDriveEnabled": true,
"formEditorEnabled": true,
"tableauEnabled": true,
"fileUploadEnabled": true,
"multipleConnectorMode": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"modelSwitchingEnabled": true,
"feedExplorerEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"parallelToolsEnabled": true,
"emailOutputEnabled": true,
"questionsToolEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"datasetId": "<string>"
},
"consoleAccess": true,
"defaultConnectorIds": [
123
],
"hideToolCells": true,
"disableEmojis": true,
"hideExampleConnectors": true,
"trainingMode": true,
"dashboardsEnabled": true,
"billingAdminId": "<string>",
"methodologyEnabled": true,
"allowAllApiAccess": true,
"feedEnabled": true,
"contextV3Enabled": true,
"bashEnabled": true,
"defaultRoutingEnabled": true,
"enabledModelIds": [
123
],
"restrictedModelIds": [
123
],
"restrictedFamilies": [
"<string>"
],
"discoverable": true,
"observabilityEnabled": true,
"notificationsEnabled": true,
"clientDbOverrideEnabled": true,
"contextReviewRequired": true,
"googleConnectorEnabled": true,
"hideApiConnectors": true,
"fastModeEnabled": true,
"maxThinkingEnabled": true,
"sandboxStateRetentionDays": 123,
"sandboxLeaseConfigEnabled": true,
"deleteInactiveThreadsEnabled": true,
"threadRetentionDays": 123,
"threadHardDeleteGraceDays": 123,
"emailOutputEnabled": true,
"defaultPlaybookPrivate": true,
"defaultDashboardOutput": true,
"defaultMethodology": 123,
"scimNewGroupDefaultRoleType": "<string>",
"groupsFeatureEnabled": true,
"availableProviders": [
"<string>"
],
"showTextqlUsage": true,
"tracesEnabled": true,
"allowLlmDataRetention": true,
"soxDbSessionMetadataEnabled": true,
"smsEnabled": true,
"scimAssignDefaultRole": true,
"migrationBannerDismissed": true,
"configMigrationsEnabled": true,
"sandboxObservabilityEnabled": true,
"dataAppsEnabled": true,
"issuesEnabled": true,
"configObjectsEnabled": true,
"configObjectsPlaybooksEnabled": true,
"configObjectsDashboardsEnabled": true,
"configAutofixEnabled": true,
"helmChartVersion": "<string>",
"spendTransparencyEnabled": true,
"sharingDisabled": true,
"appWritebackAutoApproveEnabled": true
}
}{
"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
The body is of type GetOrganizationSettingsRequest · object.
Response
Success
Show child attributes
Show child attributes
⌘I