Skip to main content
GET
/
api
/
task-templates
/
{id}
Get TaskTemplate by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/task-templates/{id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://platform.kodexa.ai/api/task-templates/{id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

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 => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)

func main() {

url := "https://platform.kodexa.ai/api/task-templates/{id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://platform.kodexa.ai/api/task-templates/{id}")
.header("x-api-key", "<api-key>")
.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::Get.new(url)
request["x-api-key"] = '<api-key>'

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-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The TaskTemplate

A task template defines a reusable task configuration with default values.

changeSequence
integer<int32>
createdOn
string<date-time>
deprecated
boolean | null
description
string
id
string
initialStatusSlug
string | null
metadata
object
name
string
organizationId
string
slug
string
template
boolean
updatedOn
string<date-time>
uuid
string