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>'
{
  "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>"
      }
    ],
    "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>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

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