Python (SDK)
import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.playbooks.update()
# Handle response
print(res)import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.playbooks.update({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"playbookId": "<string>",
"name": "<string>",
"prompt": "<string>",
"cronString": "<string>",
"datasetIds": {
"items": [
"<string>"
]
},
"connectorId": 123,
"referenceReportId": "<string>",
"paradigmOptions": {
"universal": {
"connectorIds": [
123
],
"datasetId": "<string>",
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"ontologyEditingEnabled": true,
"pythonEnabled": true,
"autoApproveEnabled": true,
"googleDriveEnabled": true,
"powerbiEnabled": true,
"contextEditingEnabled": true,
"formEditorEnabled": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"feedExplorerEnabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"streamlitEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"emailOutputEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"smsMode": true,
"apiAccessKeyIds": [
"<string>"
]
}
},
"emailAddresses": {
"items": [
"<string>"
]
},
"slackChannelId": "<string>",
"taggedSlackUserIds": {
"items": [
"<string>"
]
},
"templateHeaderId": "<string>",
"selectedTemplateDataIds": {
"items": [
"<string>"
]
},
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": {
"items": [
123
]
},
"templateDataFilters": {
"items": [
{
"field": "<string>",
"operator": "<string>",
"value": "<string>"
}
]
},
"chatAccessOverrides": {
"items": [
{
"memberId": "<string>",
"roleId": "<string>",
"accessType": "<string>"
}
]
},
"chatIsPublic": true,
"dashboardIds": {
"items": [
"<string>"
]
},
"recipientEmailColumn": "<string>",
"teamsChannelId": "<string>",
"taggedTeamsUserAadIds": {
"items": [
"<string>"
]
},
"apiAccessKeyIds": {
"items": [
"<string>"
]
}
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playbookId: '<string>',
name: '<string>',
prompt: '<string>',
cronString: '<string>',
datasetIds: {items: ['<string>']},
connectorId: 123,
referenceReportId: '<string>',
paradigmOptions: {
universal: {
connectorIds: [123],
datasetId: '<string>',
webSearchEnabled: true,
sqlEnabled: true,
ontologyEnabled: true,
ontologyEditingEnabled: true,
pythonEnabled: true,
autoApproveEnabled: true,
googleDriveEnabled: true,
powerbiEnabled: true,
contextEditingEnabled: true,
formEditorEnabled: true,
playbookToolsEnabled: true,
microsoft365Enabled: true,
feedExplorerEnabled: true,
bashEnabled: true,
javascriptEnabled: true,
feedPostEnabled: true,
feedCommentEnabled: true,
feedEngageEnabled: true,
streamlitEnabled: true,
compactionDisabled: true,
gmailEnabled: true,
chatHistorySearchEnabled: true,
googleCalendarEnabled: true,
emailOutputEnabled: true,
powerbiSelections: [
{
workspaceId: '<string>',
reportIds: ['<string>'],
datasetIds: ['<string>'],
workspaceName: '<string>',
connectorId: 123
}
],
smsMode: true,
apiAccessKeyIds: ['<string>']
}
},
emailAddresses: {items: ['<string>']},
slackChannelId: '<string>',
taggedSlackUserIds: {items: ['<string>']},
templateHeaderId: '<string>',
selectedTemplateDataIds: {items: ['<string>']},
maxConcurrentTemplates: 123,
autoOptimizeConcurrency: true,
connectorIds: {items: [123]},
templateDataFilters: {items: [{field: '<string>', operator: '<string>', value: '<string>'}]},
chatAccessOverrides: {items: [{memberId: '<string>', roleId: '<string>', accessType: '<string>'}]},
chatIsPublic: true,
dashboardIds: {items: ['<string>']},
recipientEmailColumn: '<string>',
teamsChannelId: '<string>',
taggedTeamsUserAadIds: {items: ['<string>']},
apiAccessKeyIds: {items: ['<string>']}
})
};
fetch('https://app.textql.com/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook', 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/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook",
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([
'playbookId' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'cronString' => '<string>',
'datasetIds' => [
'items' => [
'<string>'
]
],
'connectorId' => 123,
'referenceReportId' => '<string>',
'paradigmOptions' => [
'universal' => [
'connectorIds' => [
123
],
'datasetId' => '<string>',
'webSearchEnabled' => true,
'sqlEnabled' => true,
'ontologyEnabled' => true,
'ontologyEditingEnabled' => true,
'pythonEnabled' => true,
'autoApproveEnabled' => true,
'googleDriveEnabled' => true,
'powerbiEnabled' => true,
'contextEditingEnabled' => true,
'formEditorEnabled' => true,
'playbookToolsEnabled' => true,
'microsoft365Enabled' => true,
'feedExplorerEnabled' => true,
'bashEnabled' => true,
'javascriptEnabled' => true,
'feedPostEnabled' => true,
'feedCommentEnabled' => true,
'feedEngageEnabled' => true,
'streamlitEnabled' => true,
'compactionDisabled' => true,
'gmailEnabled' => true,
'chatHistorySearchEnabled' => true,
'googleCalendarEnabled' => true,
'emailOutputEnabled' => true,
'powerbiSelections' => [
[
'workspaceId' => '<string>',
'reportIds' => [
'<string>'
],
'datasetIds' => [
'<string>'
],
'workspaceName' => '<string>',
'connectorId' => 123
]
],
'smsMode' => true,
'apiAccessKeyIds' => [
'<string>'
]
]
],
'emailAddresses' => [
'items' => [
'<string>'
]
],
'slackChannelId' => '<string>',
'taggedSlackUserIds' => [
'items' => [
'<string>'
]
],
'templateHeaderId' => '<string>',
'selectedTemplateDataIds' => [
'items' => [
'<string>'
]
],
'maxConcurrentTemplates' => 123,
'autoOptimizeConcurrency' => true,
'connectorIds' => [
'items' => [
123
]
],
'templateDataFilters' => [
'items' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => '<string>'
]
]
],
'chatAccessOverrides' => [
'items' => [
[
'memberId' => '<string>',
'roleId' => '<string>',
'accessType' => '<string>'
]
]
],
'chatIsPublic' => true,
'dashboardIds' => [
'items' => [
'<string>'
]
],
'recipientEmailColumn' => '<string>',
'teamsChannelId' => '<string>',
'taggedTeamsUserAadIds' => [
'items' => [
'<string>'
]
],
'apiAccessKeyIds' => [
'items' => [
'<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/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook"
payload := strings.NewReader("{\n \"playbookId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cronString\": \"<string>\",\n \"datasetIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"connectorId\": 123,\n \"referenceReportId\": \"<string>\",\n \"paradigmOptions\": {\n \"universal\": {\n \"connectorIds\": [\n 123\n ],\n \"datasetId\": \"<string>\",\n \"webSearchEnabled\": true,\n \"sqlEnabled\": true,\n \"ontologyEnabled\": true,\n \"ontologyEditingEnabled\": true,\n \"pythonEnabled\": true,\n \"autoApproveEnabled\": true,\n \"googleDriveEnabled\": true,\n \"powerbiEnabled\": true,\n \"contextEditingEnabled\": true,\n \"formEditorEnabled\": true,\n \"playbookToolsEnabled\": true,\n \"microsoft365Enabled\": true,\n \"feedExplorerEnabled\": true,\n \"bashEnabled\": true,\n \"javascriptEnabled\": true,\n \"feedPostEnabled\": true,\n \"feedCommentEnabled\": true,\n \"feedEngageEnabled\": true,\n \"streamlitEnabled\": true,\n \"compactionDisabled\": true,\n \"gmailEnabled\": true,\n \"chatHistorySearchEnabled\": true,\n \"googleCalendarEnabled\": true,\n \"emailOutputEnabled\": true,\n \"powerbiSelections\": [\n {\n \"workspaceId\": \"<string>\",\n \"reportIds\": [\n \"<string>\"\n ],\n \"datasetIds\": [\n \"<string>\"\n ],\n \"workspaceName\": \"<string>\",\n \"connectorId\": 123\n }\n ],\n \"smsMode\": true,\n \"apiAccessKeyIds\": [\n \"<string>\"\n ]\n }\n },\n \"emailAddresses\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"slackChannelId\": \"<string>\",\n \"taggedSlackUserIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"templateHeaderId\": \"<string>\",\n \"selectedTemplateDataIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"maxConcurrentTemplates\": 123,\n \"autoOptimizeConcurrency\": true,\n \"connectorIds\": {\n \"items\": [\n 123\n ]\n },\n \"templateDataFilters\": {\n \"items\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"chatAccessOverrides\": {\n \"items\": [\n {\n \"memberId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"accessType\": \"<string>\"\n }\n ]\n },\n \"chatIsPublic\": true,\n \"dashboardIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"recipientEmailColumn\": \"<string>\",\n \"teamsChannelId\": \"<string>\",\n \"taggedTeamsUserAadIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"apiAccessKeyIds\": {\n \"items\": [\n \"<string>\"\n ]\n }\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/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playbookId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cronString\": \"<string>\",\n \"datasetIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"connectorId\": 123,\n \"referenceReportId\": \"<string>\",\n \"paradigmOptions\": {\n \"universal\": {\n \"connectorIds\": [\n 123\n ],\n \"datasetId\": \"<string>\",\n \"webSearchEnabled\": true,\n \"sqlEnabled\": true,\n \"ontologyEnabled\": true,\n \"ontologyEditingEnabled\": true,\n \"pythonEnabled\": true,\n \"autoApproveEnabled\": true,\n \"googleDriveEnabled\": true,\n \"powerbiEnabled\": true,\n \"contextEditingEnabled\": true,\n \"formEditorEnabled\": true,\n \"playbookToolsEnabled\": true,\n \"microsoft365Enabled\": true,\n \"feedExplorerEnabled\": true,\n \"bashEnabled\": true,\n \"javascriptEnabled\": true,\n \"feedPostEnabled\": true,\n \"feedCommentEnabled\": true,\n \"feedEngageEnabled\": true,\n \"streamlitEnabled\": true,\n \"compactionDisabled\": true,\n \"gmailEnabled\": true,\n \"chatHistorySearchEnabled\": true,\n \"googleCalendarEnabled\": true,\n \"emailOutputEnabled\": true,\n \"powerbiSelections\": [\n {\n \"workspaceId\": \"<string>\",\n \"reportIds\": [\n \"<string>\"\n ],\n \"datasetIds\": [\n \"<string>\"\n ],\n \"workspaceName\": \"<string>\",\n \"connectorId\": 123\n }\n ],\n \"smsMode\": true,\n \"apiAccessKeyIds\": [\n \"<string>\"\n ]\n }\n },\n \"emailAddresses\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"slackChannelId\": \"<string>\",\n \"taggedSlackUserIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"templateHeaderId\": \"<string>\",\n \"selectedTemplateDataIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"maxConcurrentTemplates\": 123,\n \"autoOptimizeConcurrency\": true,\n \"connectorIds\": {\n \"items\": [\n 123\n ]\n },\n \"templateDataFilters\": {\n \"items\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"chatAccessOverrides\": {\n \"items\": [\n {\n \"memberId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"accessType\": \"<string>\"\n }\n ]\n },\n \"chatIsPublic\": true,\n \"dashboardIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"recipientEmailColumn\": \"<string>\",\n \"teamsChannelId\": \"<string>\",\n \"taggedTeamsUserAadIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"apiAccessKeyIds\": {\n \"items\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook")
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 \"playbookId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cronString\": \"<string>\",\n \"datasetIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"connectorId\": 123,\n \"referenceReportId\": \"<string>\",\n \"paradigmOptions\": {\n \"universal\": {\n \"connectorIds\": [\n 123\n ],\n \"datasetId\": \"<string>\",\n \"webSearchEnabled\": true,\n \"sqlEnabled\": true,\n \"ontologyEnabled\": true,\n \"ontologyEditingEnabled\": true,\n \"pythonEnabled\": true,\n \"autoApproveEnabled\": true,\n \"googleDriveEnabled\": true,\n \"powerbiEnabled\": true,\n \"contextEditingEnabled\": true,\n \"formEditorEnabled\": true,\n \"playbookToolsEnabled\": true,\n \"microsoft365Enabled\": true,\n \"feedExplorerEnabled\": true,\n \"bashEnabled\": true,\n \"javascriptEnabled\": true,\n \"feedPostEnabled\": true,\n \"feedCommentEnabled\": true,\n \"feedEngageEnabled\": true,\n \"streamlitEnabled\": true,\n \"compactionDisabled\": true,\n \"gmailEnabled\": true,\n \"chatHistorySearchEnabled\": true,\n \"googleCalendarEnabled\": true,\n \"emailOutputEnabled\": true,\n \"powerbiSelections\": [\n {\n \"workspaceId\": \"<string>\",\n \"reportIds\": [\n \"<string>\"\n ],\n \"datasetIds\": [\n \"<string>\"\n ],\n \"workspaceName\": \"<string>\",\n \"connectorId\": 123\n }\n ],\n \"smsMode\": true,\n \"apiAccessKeyIds\": [\n \"<string>\"\n ]\n }\n },\n \"emailAddresses\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"slackChannelId\": \"<string>\",\n \"taggedSlackUserIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"templateHeaderId\": \"<string>\",\n \"selectedTemplateDataIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"maxConcurrentTemplates\": 123,\n \"autoOptimizeConcurrency\": true,\n \"connectorIds\": {\n \"items\": [\n 123\n ]\n },\n \"templateDataFilters\": {\n \"items\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"chatAccessOverrides\": {\n \"items\": [\n {\n \"memberId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"accessType\": \"<string>\"\n }\n ]\n },\n \"chatIsPublic\": true,\n \"dashboardIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"recipientEmailColumn\": \"<string>\",\n \"teamsChannelId\": \"<string>\",\n \"taggedTeamsUserAadIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"apiAccessKeyIds\": {\n \"items\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"playbook": {
"id": "<string>",
"orgId": "<string>",
"memberId": "<string>",
"connectorId": 123,
"name": "<string>",
"prompt": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"cronString": "<string>",
"datasetIds": [
"<string>"
],
"referenceReportId": "<string>",
"latestChatId": "<string>",
"emailAddresses": [
"<string>"
],
"slackChannelId": "<string>",
"taggedSlackUserIds": [
"<string>"
],
"paradigmOptions": {
"universal": {
"connectorIds": [
123
],
"datasetId": "<string>",
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"ontologyEditingEnabled": true,
"pythonEnabled": true,
"autoApproveEnabled": true,
"googleDriveEnabled": true,
"powerbiEnabled": true,
"contextEditingEnabled": true,
"formEditorEnabled": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"feedExplorerEnabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"streamlitEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"emailOutputEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"smsMode": true,
"apiAccessKeyIds": [
"<string>"
]
}
},
"isRunning": true,
"owner": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>",
"memberPictureUrl": "<string>"
},
"hasWritePermission": true,
"isSubscribed": true,
"templateHeaderId": "<string>",
"selectedTemplateDataIds": [
"<string>"
],
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": [
123
],
"templateDataFilters": [
{
"field": "<string>",
"operator": "<string>",
"value": "<string>"
}
],
"parentPlaybookId": "<string>",
"originPlaybookId": "<string>",
"duplicatedByMemberId": "<string>",
"duplicatedAt": "2023-11-07T05:31:56Z",
"chatAccessOverrides": [
{
"memberId": "<string>",
"roleId": "<string>",
"accessType": "<string>"
}
],
"chatIsPublic": true,
"dashboardIds": [
"<string>"
],
"recipientEmailColumn": "<string>",
"teamsChannelId": "<string>",
"taggedTeamsUserAadIds": [
"<string>"
],
"configSource": {
"filePath": "<string>",
"syncError": "<string>",
"breakingPatchId": "<string>"
},
"apiAccessKeyIds": [
"<string>"
]
}
}{
"message": "<string>",
"details": [
{
"type": "<string>",
"value": "<string>",
"debug": {}
}
]
}Playbook Service
Update Playbook
POST
/
textql.rpc.public.playbook.PlaybookService
/
UpdatePlaybook
Python (SDK)
import os
from textql_sdk import Textql
with Textql(
api_key=os.getenv("TEXTQL_API_KEY", ""),
) as textql:
res = textql.playbooks.update()
# Handle response
print(res)import { Textql } from "@textql/sdk";
const textql = new Textql({
apiKey: process.env["TEXTQL_API_KEY"] ?? "",
});
async function run() {
const result = await textql.playbooks.update({
body: {},
});
console.log(result);
}
run();curl --request POST \
--url https://app.textql.com/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook \
--header 'Connect-Protocol-Version: <connect-protocol-version>' \
--header 'Content-Type: application/json' \
--header 'tql_api_key: <api-key>' \
--data '
{
"playbookId": "<string>",
"name": "<string>",
"prompt": "<string>",
"cronString": "<string>",
"datasetIds": {
"items": [
"<string>"
]
},
"connectorId": 123,
"referenceReportId": "<string>",
"paradigmOptions": {
"universal": {
"connectorIds": [
123
],
"datasetId": "<string>",
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"ontologyEditingEnabled": true,
"pythonEnabled": true,
"autoApproveEnabled": true,
"googleDriveEnabled": true,
"powerbiEnabled": true,
"contextEditingEnabled": true,
"formEditorEnabled": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"feedExplorerEnabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"streamlitEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"emailOutputEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"smsMode": true,
"apiAccessKeyIds": [
"<string>"
]
}
},
"emailAddresses": {
"items": [
"<string>"
]
},
"slackChannelId": "<string>",
"taggedSlackUserIds": {
"items": [
"<string>"
]
},
"templateHeaderId": "<string>",
"selectedTemplateDataIds": {
"items": [
"<string>"
]
},
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": {
"items": [
123
]
},
"templateDataFilters": {
"items": [
{
"field": "<string>",
"operator": "<string>",
"value": "<string>"
}
]
},
"chatAccessOverrides": {
"items": [
{
"memberId": "<string>",
"roleId": "<string>",
"accessType": "<string>"
}
]
},
"chatIsPublic": true,
"dashboardIds": {
"items": [
"<string>"
]
},
"recipientEmailColumn": "<string>",
"teamsChannelId": "<string>",
"taggedTeamsUserAadIds": {
"items": [
"<string>"
]
},
"apiAccessKeyIds": {
"items": [
"<string>"
]
}
}
'const options = {
method: 'POST',
headers: {
'Connect-Protocol-Version': '<connect-protocol-version>',
tql_api_key: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
playbookId: '<string>',
name: '<string>',
prompt: '<string>',
cronString: '<string>',
datasetIds: {items: ['<string>']},
connectorId: 123,
referenceReportId: '<string>',
paradigmOptions: {
universal: {
connectorIds: [123],
datasetId: '<string>',
webSearchEnabled: true,
sqlEnabled: true,
ontologyEnabled: true,
ontologyEditingEnabled: true,
pythonEnabled: true,
autoApproveEnabled: true,
googleDriveEnabled: true,
powerbiEnabled: true,
contextEditingEnabled: true,
formEditorEnabled: true,
playbookToolsEnabled: true,
microsoft365Enabled: true,
feedExplorerEnabled: true,
bashEnabled: true,
javascriptEnabled: true,
feedPostEnabled: true,
feedCommentEnabled: true,
feedEngageEnabled: true,
streamlitEnabled: true,
compactionDisabled: true,
gmailEnabled: true,
chatHistorySearchEnabled: true,
googleCalendarEnabled: true,
emailOutputEnabled: true,
powerbiSelections: [
{
workspaceId: '<string>',
reportIds: ['<string>'],
datasetIds: ['<string>'],
workspaceName: '<string>',
connectorId: 123
}
],
smsMode: true,
apiAccessKeyIds: ['<string>']
}
},
emailAddresses: {items: ['<string>']},
slackChannelId: '<string>',
taggedSlackUserIds: {items: ['<string>']},
templateHeaderId: '<string>',
selectedTemplateDataIds: {items: ['<string>']},
maxConcurrentTemplates: 123,
autoOptimizeConcurrency: true,
connectorIds: {items: [123]},
templateDataFilters: {items: [{field: '<string>', operator: '<string>', value: '<string>'}]},
chatAccessOverrides: {items: [{memberId: '<string>', roleId: '<string>', accessType: '<string>'}]},
chatIsPublic: true,
dashboardIds: {items: ['<string>']},
recipientEmailColumn: '<string>',
teamsChannelId: '<string>',
taggedTeamsUserAadIds: {items: ['<string>']},
apiAccessKeyIds: {items: ['<string>']}
})
};
fetch('https://app.textql.com/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook', 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/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook",
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([
'playbookId' => '<string>',
'name' => '<string>',
'prompt' => '<string>',
'cronString' => '<string>',
'datasetIds' => [
'items' => [
'<string>'
]
],
'connectorId' => 123,
'referenceReportId' => '<string>',
'paradigmOptions' => [
'universal' => [
'connectorIds' => [
123
],
'datasetId' => '<string>',
'webSearchEnabled' => true,
'sqlEnabled' => true,
'ontologyEnabled' => true,
'ontologyEditingEnabled' => true,
'pythonEnabled' => true,
'autoApproveEnabled' => true,
'googleDriveEnabled' => true,
'powerbiEnabled' => true,
'contextEditingEnabled' => true,
'formEditorEnabled' => true,
'playbookToolsEnabled' => true,
'microsoft365Enabled' => true,
'feedExplorerEnabled' => true,
'bashEnabled' => true,
'javascriptEnabled' => true,
'feedPostEnabled' => true,
'feedCommentEnabled' => true,
'feedEngageEnabled' => true,
'streamlitEnabled' => true,
'compactionDisabled' => true,
'gmailEnabled' => true,
'chatHistorySearchEnabled' => true,
'googleCalendarEnabled' => true,
'emailOutputEnabled' => true,
'powerbiSelections' => [
[
'workspaceId' => '<string>',
'reportIds' => [
'<string>'
],
'datasetIds' => [
'<string>'
],
'workspaceName' => '<string>',
'connectorId' => 123
]
],
'smsMode' => true,
'apiAccessKeyIds' => [
'<string>'
]
]
],
'emailAddresses' => [
'items' => [
'<string>'
]
],
'slackChannelId' => '<string>',
'taggedSlackUserIds' => [
'items' => [
'<string>'
]
],
'templateHeaderId' => '<string>',
'selectedTemplateDataIds' => [
'items' => [
'<string>'
]
],
'maxConcurrentTemplates' => 123,
'autoOptimizeConcurrency' => true,
'connectorIds' => [
'items' => [
123
]
],
'templateDataFilters' => [
'items' => [
[
'field' => '<string>',
'operator' => '<string>',
'value' => '<string>'
]
]
],
'chatAccessOverrides' => [
'items' => [
[
'memberId' => '<string>',
'roleId' => '<string>',
'accessType' => '<string>'
]
]
],
'chatIsPublic' => true,
'dashboardIds' => [
'items' => [
'<string>'
]
],
'recipientEmailColumn' => '<string>',
'teamsChannelId' => '<string>',
'taggedTeamsUserAadIds' => [
'items' => [
'<string>'
]
],
'apiAccessKeyIds' => [
'items' => [
'<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/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook"
payload := strings.NewReader("{\n \"playbookId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cronString\": \"<string>\",\n \"datasetIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"connectorId\": 123,\n \"referenceReportId\": \"<string>\",\n \"paradigmOptions\": {\n \"universal\": {\n \"connectorIds\": [\n 123\n ],\n \"datasetId\": \"<string>\",\n \"webSearchEnabled\": true,\n \"sqlEnabled\": true,\n \"ontologyEnabled\": true,\n \"ontologyEditingEnabled\": true,\n \"pythonEnabled\": true,\n \"autoApproveEnabled\": true,\n \"googleDriveEnabled\": true,\n \"powerbiEnabled\": true,\n \"contextEditingEnabled\": true,\n \"formEditorEnabled\": true,\n \"playbookToolsEnabled\": true,\n \"microsoft365Enabled\": true,\n \"feedExplorerEnabled\": true,\n \"bashEnabled\": true,\n \"javascriptEnabled\": true,\n \"feedPostEnabled\": true,\n \"feedCommentEnabled\": true,\n \"feedEngageEnabled\": true,\n \"streamlitEnabled\": true,\n \"compactionDisabled\": true,\n \"gmailEnabled\": true,\n \"chatHistorySearchEnabled\": true,\n \"googleCalendarEnabled\": true,\n \"emailOutputEnabled\": true,\n \"powerbiSelections\": [\n {\n \"workspaceId\": \"<string>\",\n \"reportIds\": [\n \"<string>\"\n ],\n \"datasetIds\": [\n \"<string>\"\n ],\n \"workspaceName\": \"<string>\",\n \"connectorId\": 123\n }\n ],\n \"smsMode\": true,\n \"apiAccessKeyIds\": [\n \"<string>\"\n ]\n }\n },\n \"emailAddresses\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"slackChannelId\": \"<string>\",\n \"taggedSlackUserIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"templateHeaderId\": \"<string>\",\n \"selectedTemplateDataIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"maxConcurrentTemplates\": 123,\n \"autoOptimizeConcurrency\": true,\n \"connectorIds\": {\n \"items\": [\n 123\n ]\n },\n \"templateDataFilters\": {\n \"items\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"chatAccessOverrides\": {\n \"items\": [\n {\n \"memberId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"accessType\": \"<string>\"\n }\n ]\n },\n \"chatIsPublic\": true,\n \"dashboardIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"recipientEmailColumn\": \"<string>\",\n \"teamsChannelId\": \"<string>\",\n \"taggedTeamsUserAadIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"apiAccessKeyIds\": {\n \"items\": [\n \"<string>\"\n ]\n }\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/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook")
.header("Connect-Protocol-Version", "<connect-protocol-version>")
.header("tql_api_key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"playbookId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cronString\": \"<string>\",\n \"datasetIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"connectorId\": 123,\n \"referenceReportId\": \"<string>\",\n \"paradigmOptions\": {\n \"universal\": {\n \"connectorIds\": [\n 123\n ],\n \"datasetId\": \"<string>\",\n \"webSearchEnabled\": true,\n \"sqlEnabled\": true,\n \"ontologyEnabled\": true,\n \"ontologyEditingEnabled\": true,\n \"pythonEnabled\": true,\n \"autoApproveEnabled\": true,\n \"googleDriveEnabled\": true,\n \"powerbiEnabled\": true,\n \"contextEditingEnabled\": true,\n \"formEditorEnabled\": true,\n \"playbookToolsEnabled\": true,\n \"microsoft365Enabled\": true,\n \"feedExplorerEnabled\": true,\n \"bashEnabled\": true,\n \"javascriptEnabled\": true,\n \"feedPostEnabled\": true,\n \"feedCommentEnabled\": true,\n \"feedEngageEnabled\": true,\n \"streamlitEnabled\": true,\n \"compactionDisabled\": true,\n \"gmailEnabled\": true,\n \"chatHistorySearchEnabled\": true,\n \"googleCalendarEnabled\": true,\n \"emailOutputEnabled\": true,\n \"powerbiSelections\": [\n {\n \"workspaceId\": \"<string>\",\n \"reportIds\": [\n \"<string>\"\n ],\n \"datasetIds\": [\n \"<string>\"\n ],\n \"workspaceName\": \"<string>\",\n \"connectorId\": 123\n }\n ],\n \"smsMode\": true,\n \"apiAccessKeyIds\": [\n \"<string>\"\n ]\n }\n },\n \"emailAddresses\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"slackChannelId\": \"<string>\",\n \"taggedSlackUserIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"templateHeaderId\": \"<string>\",\n \"selectedTemplateDataIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"maxConcurrentTemplates\": 123,\n \"autoOptimizeConcurrency\": true,\n \"connectorIds\": {\n \"items\": [\n 123\n ]\n },\n \"templateDataFilters\": {\n \"items\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"chatAccessOverrides\": {\n \"items\": [\n {\n \"memberId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"accessType\": \"<string>\"\n }\n ]\n },\n \"chatIsPublic\": true,\n \"dashboardIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"recipientEmailColumn\": \"<string>\",\n \"teamsChannelId\": \"<string>\",\n \"taggedTeamsUserAadIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"apiAccessKeyIds\": {\n \"items\": [\n \"<string>\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.textql.com/textql.rpc.public.playbook.PlaybookService/UpdatePlaybook")
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 \"playbookId\": \"<string>\",\n \"name\": \"<string>\",\n \"prompt\": \"<string>\",\n \"cronString\": \"<string>\",\n \"datasetIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"connectorId\": 123,\n \"referenceReportId\": \"<string>\",\n \"paradigmOptions\": {\n \"universal\": {\n \"connectorIds\": [\n 123\n ],\n \"datasetId\": \"<string>\",\n \"webSearchEnabled\": true,\n \"sqlEnabled\": true,\n \"ontologyEnabled\": true,\n \"ontologyEditingEnabled\": true,\n \"pythonEnabled\": true,\n \"autoApproveEnabled\": true,\n \"googleDriveEnabled\": true,\n \"powerbiEnabled\": true,\n \"contextEditingEnabled\": true,\n \"formEditorEnabled\": true,\n \"playbookToolsEnabled\": true,\n \"microsoft365Enabled\": true,\n \"feedExplorerEnabled\": true,\n \"bashEnabled\": true,\n \"javascriptEnabled\": true,\n \"feedPostEnabled\": true,\n \"feedCommentEnabled\": true,\n \"feedEngageEnabled\": true,\n \"streamlitEnabled\": true,\n \"compactionDisabled\": true,\n \"gmailEnabled\": true,\n \"chatHistorySearchEnabled\": true,\n \"googleCalendarEnabled\": true,\n \"emailOutputEnabled\": true,\n \"powerbiSelections\": [\n {\n \"workspaceId\": \"<string>\",\n \"reportIds\": [\n \"<string>\"\n ],\n \"datasetIds\": [\n \"<string>\"\n ],\n \"workspaceName\": \"<string>\",\n \"connectorId\": 123\n }\n ],\n \"smsMode\": true,\n \"apiAccessKeyIds\": [\n \"<string>\"\n ]\n }\n },\n \"emailAddresses\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"slackChannelId\": \"<string>\",\n \"taggedSlackUserIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"templateHeaderId\": \"<string>\",\n \"selectedTemplateDataIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"maxConcurrentTemplates\": 123,\n \"autoOptimizeConcurrency\": true,\n \"connectorIds\": {\n \"items\": [\n 123\n ]\n },\n \"templateDataFilters\": {\n \"items\": [\n {\n \"field\": \"<string>\",\n \"operator\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n },\n \"chatAccessOverrides\": {\n \"items\": [\n {\n \"memberId\": \"<string>\",\n \"roleId\": \"<string>\",\n \"accessType\": \"<string>\"\n }\n ]\n },\n \"chatIsPublic\": true,\n \"dashboardIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"recipientEmailColumn\": \"<string>\",\n \"teamsChannelId\": \"<string>\",\n \"taggedTeamsUserAadIds\": {\n \"items\": [\n \"<string>\"\n ]\n },\n \"apiAccessKeyIds\": {\n \"items\": [\n \"<string>\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"playbook": {
"id": "<string>",
"orgId": "<string>",
"memberId": "<string>",
"connectorId": 123,
"name": "<string>",
"prompt": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"cronString": "<string>",
"datasetIds": [
"<string>"
],
"referenceReportId": "<string>",
"latestChatId": "<string>",
"emailAddresses": [
"<string>"
],
"slackChannelId": "<string>",
"taggedSlackUserIds": [
"<string>"
],
"paradigmOptions": {
"universal": {
"connectorIds": [
123
],
"datasetId": "<string>",
"webSearchEnabled": true,
"sqlEnabled": true,
"ontologyEnabled": true,
"ontologyEditingEnabled": true,
"pythonEnabled": true,
"autoApproveEnabled": true,
"googleDriveEnabled": true,
"powerbiEnabled": true,
"contextEditingEnabled": true,
"formEditorEnabled": true,
"playbookToolsEnabled": true,
"microsoft365Enabled": true,
"feedExplorerEnabled": true,
"bashEnabled": true,
"javascriptEnabled": true,
"feedPostEnabled": true,
"feedCommentEnabled": true,
"feedEngageEnabled": true,
"streamlitEnabled": true,
"compactionDisabled": true,
"gmailEnabled": true,
"chatHistorySearchEnabled": true,
"googleCalendarEnabled": true,
"emailOutputEnabled": true,
"powerbiSelections": [
{
"workspaceId": "<string>",
"reportIds": [
"<string>"
],
"datasetIds": [
"<string>"
],
"workspaceName": "<string>",
"connectorId": 123
}
],
"smsMode": true,
"apiAccessKeyIds": [
"<string>"
]
}
},
"isRunning": true,
"owner": {
"memberId": "<string>",
"memberEmail": "<string>",
"memberName": "<string>",
"memberPictureUrl": "<string>"
},
"hasWritePermission": true,
"isSubscribed": true,
"templateHeaderId": "<string>",
"selectedTemplateDataIds": [
"<string>"
],
"maxConcurrentTemplates": 123,
"autoOptimizeConcurrency": true,
"connectorIds": [
123
],
"templateDataFilters": [
{
"field": "<string>",
"operator": "<string>",
"value": "<string>"
}
],
"parentPlaybookId": "<string>",
"originPlaybookId": "<string>",
"duplicatedByMemberId": "<string>",
"duplicatedAt": "2023-11-07T05:31:56Z",
"chatAccessOverrides": [
{
"memberId": "<string>",
"roleId": "<string>",
"accessType": "<string>"
}
],
"chatIsPublic": true,
"dashboardIds": [
"<string>"
],
"recipientEmailColumn": "<string>",
"teamsChannelId": "<string>",
"taggedTeamsUserAadIds": [
"<string>"
],
"configSource": {
"filePath": "<string>",
"syncError": "<string>",
"breakingPatchId": "<string>"
},
"apiAccessKeyIds": [
"<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
Available options:
STATUS_UNKNOWN, STATUS_ACTIVE, STATUS_INACTIVE, STATUS_EMPTY, ALL_PLAYBOOKS Available options:
TRIGGER_TYPE_UNKNOWN, TRIGGER_TYPE_CRON, TRIGGER_TYPE_WEBHOOK Show child attributes
Show child attributes
Deprecated: use connector_ids instead
Show child attributes
Show child attributes
Available options:
TYPE_UNKNOWN, TYPE_UNIVERSAL Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
REPORT_STYLE_UNKNOWN, EXECUTIVE_REPORT, VERBOSE, CONCISE Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
MODEL_UNKNOWN, MODEL_DEFAULT_SMALL, MODEL_DEFAULT, MODEL_DEFAULT_LARGE, MODEL_DEFAULT_REASONING, MODEL_HAIKU_4_5, MODEL_OPUS_4_8, MODEL_FABLE_5, MODEL_SONNET_5, MODEL_GPT_5_6_SOL, MODEL_GEMINI_3_FLASH, MODEL_GEMINI_3_PRO, MODEL_GEMINI_3_1_PRO, MODEL_GEMINI_3_5_FLASH, MODEL_GPT_5_6_TERRA, MODEL_GPT_5_6_LUNA, MODEL_DEEPSEEK_3_2, MODEL_GLM_5, MODEL_VLLM, MODEL_KIMI_K2_6, MODEL_GLM_5_2, MODEL_KIMI_K2_7_CODE, MODEL_QWEN3_7_PLUS, MODEL_MUSE_SPARK_1_1 Available options:
CHAT_ACCESS_MODE_INHERIT, CHAT_ACCESS_MODE_CUSTOM Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Success
Show child attributes
Show child attributes
⌘I