Update TaskTemplate
curl --request PUT \
--url https://platform.kodexa.ai/api/task-templates/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"id": "<string>",
"initialStatusSlug": "<string>",
"metadata": {
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<string>"
}
],
"aiNaming": {
"enabled": true,
"prompt": "<string>"
},
"chatPrompt": {
"enabled": true,
"prompt": "<string>"
},
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"documentFamilyGroups": [
{
"automaticallyAdd": true,
"documentFamilyFilter": "<string>",
"editable": true,
"hardMaxPages": 123,
"knowledgeFeatures": [
{
"featureTypeRef": "<string>",
"required": true
}
],
"maxHits": 123,
"maxPages": 123,
"maxSize": 123,
"name": "<string>",
"notes": "<string>",
"sort": "<string>",
"titlePrompt": "<string>",
"uniqueFilenames": true,
"uploadOnly": true
}
],
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"forms": [
{
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"availablePanels": {},
"dataFormRef": "<string>",
"properties": {}
}
],
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"priority": 123,
"properties": {},
"teamSlug": "<string>",
"workspaceId": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/task-templates/{id}"
payload = {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": True,
"description": "<string>",
"id": "<string>",
"initialStatusSlug": "<string>",
"metadata": {
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<string>"
}
],
"aiNaming": {
"enabled": True,
"prompt": "<string>"
},
"chatPrompt": {
"enabled": True,
"prompt": "<string>"
},
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"documentFamilyGroups": [
{
"automaticallyAdd": True,
"documentFamilyFilter": "<string>",
"editable": True,
"hardMaxPages": 123,
"knowledgeFeatures": [
{
"featureTypeRef": "<string>",
"required": True
}
],
"maxHits": 123,
"maxPages": 123,
"maxSize": 123,
"name": "<string>",
"notes": "<string>",
"sort": "<string>",
"titlePrompt": "<string>",
"uniqueFilenames": True,
"uploadOnly": True
}
],
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"forms": [
{
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"availablePanels": {},
"dataFormRef": "<string>",
"properties": {}
}
],
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"priority": 123,
"properties": {},
"teamSlug": "<string>",
"workspaceId": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"slug": "<string>",
"template": True,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deprecated: true,
description: '<string>',
id: '<string>',
initialStatusSlug: '<string>',
metadata: {
actions: [{label: '<string>', properties: {}, type: '<string>', uuid: '<string>'}],
agentShortcuts: [{icon: '<string>', id: '<string>', label: '<string>', prompt: '<string>'}],
aiNaming: {enabled: true, prompt: '<string>'},
chatPrompt: {enabled: true, prompt: '<string>'},
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
documentFamilyGroups: [
{
automaticallyAdd: true,
documentFamilyFilter: '<string>',
editable: true,
hardMaxPages: 123,
knowledgeFeatures: [{featureTypeRef: '<string>', required: true}],
maxHits: 123,
maxPages: 123,
maxSize: 123,
name: '<string>',
notes: '<string>',
sort: '<string>',
titlePrompt: '<string>',
uniqueFilenames: true,
uploadOnly: true
}
],
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
forms: [
{
actions: [{label: '<string>', properties: {}, type: '<string>', uuid: '<string>'}],
availablePanels: {},
dataFormRef: '<string>',
properties: {}
}
],
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
priority: 123,
properties: {},
teamSlug: '<string>',
workspaceId: '<string>'
},
name: '<string>',
organizationId: '<string>',
slug: '<string>',
template: true,
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/task-templates/{id}', 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://platform.kodexa.ai/api/task-templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deprecated' => true,
'description' => '<string>',
'id' => '<string>',
'initialStatusSlug' => '<string>',
'metadata' => [
'actions' => [
[
'label' => '<string>',
'properties' => [
],
'type' => '<string>',
'uuid' => '<string>'
]
],
'agentShortcuts' => [
[
'icon' => '<string>',
'id' => '<string>',
'label' => '<string>',
'prompt' => '<string>'
]
],
'aiNaming' => [
'enabled' => true,
'prompt' => '<string>'
],
'chatPrompt' => [
'enabled' => true,
'prompt' => '<string>'
],
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'documentFamilyGroups' => [
[
'automaticallyAdd' => true,
'documentFamilyFilter' => '<string>',
'editable' => true,
'hardMaxPages' => 123,
'knowledgeFeatures' => [
[
'featureTypeRef' => '<string>',
'required' => true
]
],
'maxHits' => 123,
'maxPages' => 123,
'maxSize' => 123,
'name' => '<string>',
'notes' => '<string>',
'sort' => '<string>',
'titlePrompt' => '<string>',
'uniqueFilenames' => true,
'uploadOnly' => true
]
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'forms' => [
[
'actions' => [
[
'label' => '<string>',
'properties' => [
],
'type' => '<string>',
'uuid' => '<string>'
]
],
'availablePanels' => [
],
'dataFormRef' => '<string>',
'properties' => [
]
]
],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'priority' => 123,
'properties' => [
],
'teamSlug' => '<string>',
'workspaceId' => '<string>'
],
'name' => '<string>',
'organizationId' => '<string>',
'slug' => '<string>',
'template' => true,
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://platform.kodexa.ai/api/task-templates/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"initialStatusSlug\": \"<string>\",\n \"metadata\": {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"agentShortcuts\": [\n {\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"aiNaming\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"chatPrompt\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"documentFamilyGroups\": [\n {\n \"automaticallyAdd\": true,\n \"documentFamilyFilter\": \"<string>\",\n \"editable\": true,\n \"hardMaxPages\": 123,\n \"knowledgeFeatures\": [\n {\n \"featureTypeRef\": \"<string>\",\n \"required\": true\n }\n ],\n \"maxHits\": 123,\n \"maxPages\": 123,\n \"maxSize\": 123,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"sort\": \"<string>\",\n \"titlePrompt\": \"<string>\",\n \"uniqueFilenames\": true,\n \"uploadOnly\": true\n }\n ],\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"forms\": [\n {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"availablePanels\": {},\n \"dataFormRef\": \"<string>\",\n \"properties\": {}\n }\n ],\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"priority\": 123,\n \"properties\": {},\n \"teamSlug\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"slug\": \"<string>\",\n \"template\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-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.put("https://platform.kodexa.ai/api/task-templates/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"initialStatusSlug\": \"<string>\",\n \"metadata\": {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"agentShortcuts\": [\n {\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"aiNaming\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"chatPrompt\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"documentFamilyGroups\": [\n {\n \"automaticallyAdd\": true,\n \"documentFamilyFilter\": \"<string>\",\n \"editable\": true,\n \"hardMaxPages\": 123,\n \"knowledgeFeatures\": [\n {\n \"featureTypeRef\": \"<string>\",\n \"required\": true\n }\n ],\n \"maxHits\": 123,\n \"maxPages\": 123,\n \"maxSize\": 123,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"sort\": \"<string>\",\n \"titlePrompt\": \"<string>\",\n \"uniqueFilenames\": true,\n \"uploadOnly\": true\n }\n ],\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"forms\": [\n {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"availablePanels\": {},\n \"dataFormRef\": \"<string>\",\n \"properties\": {}\n }\n ],\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"priority\": 123,\n \"properties\": {},\n \"teamSlug\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"slug\": \"<string>\",\n \"template\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/task-templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"initialStatusSlug\": \"<string>\",\n \"metadata\": {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"agentShortcuts\": [\n {\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"aiNaming\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"chatPrompt\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"documentFamilyGroups\": [\n {\n \"automaticallyAdd\": true,\n \"documentFamilyFilter\": \"<string>\",\n \"editable\": true,\n \"hardMaxPages\": 123,\n \"knowledgeFeatures\": [\n {\n \"featureTypeRef\": \"<string>\",\n \"required\": true\n }\n ],\n \"maxHits\": 123,\n \"maxPages\": 123,\n \"maxSize\": 123,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"sort\": \"<string>\",\n \"titlePrompt\": \"<string>\",\n \"uniqueFilenames\": true,\n \"uploadOnly\": true\n }\n ],\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"forms\": [\n {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"availablePanels\": {},\n \"dataFormRef\": \"<string>\",\n \"properties\": {}\n }\n ],\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"priority\": 123,\n \"properties\": {},\n \"teamSlug\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"slug\": \"<string>\",\n \"template\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"id": "<string>",
"initialStatusSlug": "<string>",
"metadata": {
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<string>"
}
],
"aiNaming": {
"enabled": true,
"prompt": "<string>"
},
"chatPrompt": {
"enabled": true,
"prompt": "<string>"
},
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"documentFamilyGroups": [
{
"automaticallyAdd": true,
"documentFamilyFilter": "<string>",
"editable": true,
"hardMaxPages": 123,
"knowledgeFeatures": [
{
"featureTypeRef": "<string>",
"required": true
}
],
"maxHits": 123,
"maxPages": 123,
"maxSize": 123,
"name": "<string>",
"notes": "<string>",
"sort": "<string>",
"titlePrompt": "<string>",
"uniqueFilenames": true,
"uploadOnly": true
}
],
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"forms": [
{
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"availablePanels": {},
"dataFormRef": "<string>",
"properties": {}
}
],
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"priority": 123,
"properties": {},
"teamSlug": "<string>",
"workspaceId": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}TaskTemplates
Update TaskTemplate
Updates an existing TaskTemplate. Task templates define reusable task configurations with default values.
PUT
/
api
/
task-templates
/
{id}
Update TaskTemplate
curl --request PUT \
--url https://platform.kodexa.ai/api/task-templates/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"id": "<string>",
"initialStatusSlug": "<string>",
"metadata": {
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<string>"
}
],
"aiNaming": {
"enabled": true,
"prompt": "<string>"
},
"chatPrompt": {
"enabled": true,
"prompt": "<string>"
},
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"documentFamilyGroups": [
{
"automaticallyAdd": true,
"documentFamilyFilter": "<string>",
"editable": true,
"hardMaxPages": 123,
"knowledgeFeatures": [
{
"featureTypeRef": "<string>",
"required": true
}
],
"maxHits": 123,
"maxPages": 123,
"maxSize": 123,
"name": "<string>",
"notes": "<string>",
"sort": "<string>",
"titlePrompt": "<string>",
"uniqueFilenames": true,
"uploadOnly": true
}
],
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"forms": [
{
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"availablePanels": {},
"dataFormRef": "<string>",
"properties": {}
}
],
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"priority": 123,
"properties": {},
"teamSlug": "<string>",
"workspaceId": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'import requests
url = "https://platform.kodexa.ai/api/task-templates/{id}"
payload = {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": True,
"description": "<string>",
"id": "<string>",
"initialStatusSlug": "<string>",
"metadata": {
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<string>"
}
],
"aiNaming": {
"enabled": True,
"prompt": "<string>"
},
"chatPrompt": {
"enabled": True,
"prompt": "<string>"
},
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"documentFamilyGroups": [
{
"automaticallyAdd": True,
"documentFamilyFilter": "<string>",
"editable": True,
"hardMaxPages": 123,
"knowledgeFeatures": [
{
"featureTypeRef": "<string>",
"required": True
}
],
"maxHits": 123,
"maxPages": 123,
"maxSize": 123,
"name": "<string>",
"notes": "<string>",
"sort": "<string>",
"titlePrompt": "<string>",
"uniqueFilenames": True,
"uploadOnly": True
}
],
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"forms": [
{
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"availablePanels": {},
"dataFormRef": "<string>",
"properties": {}
}
],
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"priority": 123,
"properties": {},
"teamSlug": "<string>",
"workspaceId": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"slug": "<string>",
"template": True,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
deprecated: true,
description: '<string>',
id: '<string>',
initialStatusSlug: '<string>',
metadata: {
actions: [{label: '<string>', properties: {}, type: '<string>', uuid: '<string>'}],
agentShortcuts: [{icon: '<string>', id: '<string>', label: '<string>', prompt: '<string>'}],
aiNaming: {enabled: true, prompt: '<string>'},
chatPrompt: {enabled: true, prompt: '<string>'},
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
documentFamilyGroups: [
{
automaticallyAdd: true,
documentFamilyFilter: '<string>',
editable: true,
hardMaxPages: 123,
knowledgeFeatures: [{featureTypeRef: '<string>', required: true}],
maxHits: 123,
maxPages: 123,
maxSize: 123,
name: '<string>',
notes: '<string>',
sort: '<string>',
titlePrompt: '<string>',
uniqueFilenames: true,
uploadOnly: true
}
],
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
forms: [
{
actions: [{label: '<string>', properties: {}, type: '<string>', uuid: '<string>'}],
availablePanels: {},
dataFormRef: '<string>',
properties: {}
}
],
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
priority: 123,
properties: {},
teamSlug: '<string>',
workspaceId: '<string>'
},
name: '<string>',
organizationId: '<string>',
slug: '<string>',
template: true,
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
})
};
fetch('https://platform.kodexa.ai/api/task-templates/{id}', 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://platform.kodexa.ai/api/task-templates/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'deprecated' => true,
'description' => '<string>',
'id' => '<string>',
'initialStatusSlug' => '<string>',
'metadata' => [
'actions' => [
[
'label' => '<string>',
'properties' => [
],
'type' => '<string>',
'uuid' => '<string>'
]
],
'agentShortcuts' => [
[
'icon' => '<string>',
'id' => '<string>',
'label' => '<string>',
'prompt' => '<string>'
]
],
'aiNaming' => [
'enabled' => true,
'prompt' => '<string>'
],
'chatPrompt' => [
'enabled' => true,
'prompt' => '<string>'
],
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'documentFamilyGroups' => [
[
'automaticallyAdd' => true,
'documentFamilyFilter' => '<string>',
'editable' => true,
'hardMaxPages' => 123,
'knowledgeFeatures' => [
[
'featureTypeRef' => '<string>',
'required' => true
]
],
'maxHits' => 123,
'maxPages' => 123,
'maxSize' => 123,
'name' => '<string>',
'notes' => '<string>',
'sort' => '<string>',
'titlePrompt' => '<string>',
'uniqueFilenames' => true,
'uploadOnly' => true
]
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'forms' => [
[
'actions' => [
[
'label' => '<string>',
'properties' => [
],
'type' => '<string>',
'uuid' => '<string>'
]
],
'availablePanels' => [
],
'dataFormRef' => '<string>',
'properties' => [
]
]
],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'priority' => 123,
'properties' => [
],
'teamSlug' => '<string>',
'workspaceId' => '<string>'
],
'name' => '<string>',
'organizationId' => '<string>',
'slug' => '<string>',
'template' => true,
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-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://platform.kodexa.ai/api/task-templates/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"initialStatusSlug\": \"<string>\",\n \"metadata\": {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"agentShortcuts\": [\n {\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"aiNaming\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"chatPrompt\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"documentFamilyGroups\": [\n {\n \"automaticallyAdd\": true,\n \"documentFamilyFilter\": \"<string>\",\n \"editable\": true,\n \"hardMaxPages\": 123,\n \"knowledgeFeatures\": [\n {\n \"featureTypeRef\": \"<string>\",\n \"required\": true\n }\n ],\n \"maxHits\": 123,\n \"maxPages\": 123,\n \"maxSize\": 123,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"sort\": \"<string>\",\n \"titlePrompt\": \"<string>\",\n \"uniqueFilenames\": true,\n \"uploadOnly\": true\n }\n ],\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"forms\": [\n {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"availablePanels\": {},\n \"dataFormRef\": \"<string>\",\n \"properties\": {}\n }\n ],\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"priority\": 123,\n \"properties\": {},\n \"teamSlug\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"slug\": \"<string>\",\n \"template\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-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.put("https://platform.kodexa.ai/api/task-templates/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"initialStatusSlug\": \"<string>\",\n \"metadata\": {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"agentShortcuts\": [\n {\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"aiNaming\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"chatPrompt\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"documentFamilyGroups\": [\n {\n \"automaticallyAdd\": true,\n \"documentFamilyFilter\": \"<string>\",\n \"editable\": true,\n \"hardMaxPages\": 123,\n \"knowledgeFeatures\": [\n {\n \"featureTypeRef\": \"<string>\",\n \"required\": true\n }\n ],\n \"maxHits\": 123,\n \"maxPages\": 123,\n \"maxSize\": 123,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"sort\": \"<string>\",\n \"titlePrompt\": \"<string>\",\n \"uniqueFilenames\": true,\n \"uploadOnly\": true\n }\n ],\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"forms\": [\n {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"availablePanels\": {},\n \"dataFormRef\": \"<string>\",\n \"properties\": {}\n }\n ],\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"priority\": 123,\n \"properties\": {},\n \"teamSlug\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"slug\": \"<string>\",\n \"template\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/task-templates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deprecated\": true,\n \"description\": \"<string>\",\n \"id\": \"<string>\",\n \"initialStatusSlug\": \"<string>\",\n \"metadata\": {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"agentShortcuts\": [\n {\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"label\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n ],\n \"aiNaming\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"chatPrompt\": {\n \"enabled\": true,\n \"prompt\": \"<string>\"\n },\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"documentFamilyGroups\": [\n {\n \"automaticallyAdd\": true,\n \"documentFamilyFilter\": \"<string>\",\n \"editable\": true,\n \"hardMaxPages\": 123,\n \"knowledgeFeatures\": [\n {\n \"featureTypeRef\": \"<string>\",\n \"required\": true\n }\n ],\n \"maxHits\": 123,\n \"maxPages\": 123,\n \"maxSize\": 123,\n \"name\": \"<string>\",\n \"notes\": \"<string>\",\n \"sort\": \"<string>\",\n \"titlePrompt\": \"<string>\",\n \"uniqueFilenames\": true,\n \"uploadOnly\": true\n }\n ],\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"forms\": [\n {\n \"actions\": [\n {\n \"label\": \"<string>\",\n \"properties\": {},\n \"type\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ],\n \"availablePanels\": {},\n \"dataFormRef\": \"<string>\",\n \"properties\": {}\n }\n ],\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"priority\": 123,\n \"properties\": {},\n \"teamSlug\": \"<string>\",\n \"workspaceId\": \"<string>\"\n },\n \"name\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"slug\": \"<string>\",\n \"template\": true,\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"description": "<string>",
"id": "<string>",
"initialStatusSlug": "<string>",
"metadata": {
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"agentShortcuts": [
{
"icon": "<string>",
"id": "<string>",
"label": "<string>",
"prompt": "<string>"
}
],
"aiNaming": {
"enabled": true,
"prompt": "<string>"
},
"chatPrompt": {
"enabled": true,
"prompt": "<string>"
},
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"documentFamilyGroups": [
{
"automaticallyAdd": true,
"documentFamilyFilter": "<string>",
"editable": true,
"hardMaxPages": 123,
"knowledgeFeatures": [
{
"featureTypeRef": "<string>",
"required": true
}
],
"maxHits": 123,
"maxPages": 123,
"maxSize": 123,
"name": "<string>",
"notes": "<string>",
"sort": "<string>",
"titlePrompt": "<string>",
"uniqueFilenames": true,
"uploadOnly": true
}
],
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"forms": [
{
"actions": [
{
"label": "<string>",
"properties": {},
"type": "<string>",
"uuid": "<string>"
}
],
"availablePanels": {},
"dataFormRef": "<string>",
"properties": {}
}
],
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"priority": 123,
"properties": {},
"teamSlug": "<string>",
"workspaceId": "<string>"
},
"name": "<string>",
"organizationId": "<string>",
"slug": "<string>",
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
application/json
A task template defines a reusable task configuration with default values.
Response
Updated TaskTemplate
A task template defines a reusable task configuration with default values.
⌘I