Skip to main content
GET
/
api
/
project-templates
List Project Templates
curl --request GET \
  --url https://platform.kodexa.ai/api/project-templates \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "deprecated": true,
      "extensionPackRef": "<string>",
      "id": "<string>",
      "metadata": {
        "assistants": [
          {
            "assistantDefinitionRef": "<string>",
            "assistantRole": "<string>",
            "chatEnabled": true,
            "connections": [
              {
                "sourceRef": "<string>",
                "sourceType": "STORE",
                "subscription": "<string>",
                "targetRef": "<string>",
                "targetType": "STORE"
              }
            ],
            "description": "<string>",
            "loggingEnabled": true,
            "name": "<string>",
            "options": {},
            "priorityHint": 123,
            "schedules": [
              {
                "cronExpression": "<string>",
                "type": "<string>"
              }
            ],
            "showInTraining": true,
            "slug": "<string>",
            "stores": [
              "<string>"
            ],
            "subscription": "<string>"
          }
        ],
        "attributeStatuses": [
          {
            "color": "<string>",
            "icon": "<string>",
            "status": "<string>",
            "statusType": "UNRESOLVED"
          }
        ],
        "checksum": "<string>",
        "dataForms": [
          {
            "cards": {},
            "description": "<string>",
            "entrypoints": [
              "<string>"
            ],
            "name": "<string>",
            "ref": "<string>",
            "slug": "<string>",
            "templateRef": "<string>"
          }
        ],
        "deleteProtection": true,
        "deprecated": true,
        "description": "<string>",
        "documentStatuses": [
          {
            "color": "<string>",
            "icon": "<string>",
            "oldIdentifier": "<string>",
            "slug": "<string>",
            "status": "<string>",
            "statusType": "UNRESOLVED"
          }
        ],
        "extensionPackRef": "<string>",
        "helpUrl": "<string>",
        "icon": "<string>",
        "id": "<string>",
        "imageUrl": "<string>",
        "knowledgeSets": [
          {
            "active": true,
            "clauses": [
              {
                "features": [
                  {
                    "featureUuid": "<string>",
                    "positive": true
                  }
                ]
              }
            ],
            "description": "<string>",
            "featureExpression": {
              "children": "<array>",
              "slug": "<string>",
              "type": "FEATURE"
            },
            "features": [
              {
                "active": true,
                "featureTypeRef": "<string>",
                "originalFeatureId": "<string>",
                "properties": {},
                "slug": "<string>",
                "uuid": "<string>"
              }
            ],
            "knowledgeItems": [
              {
                "active": true,
                "description": "<string>",
                "knowledgeItemTypeRef": "<string>",
                "properties": {},
                "sequenceOrder": 123,
                "slug": "<string>",
                "title": "<string>"
              }
            ],
            "name": "<string>",
            "ref": "<string>",
            "setType": "<string>",
            "showOnNewProject": true,
            "slug": "<string>"
          }
        ],
        "memory": {
          "changeSequence": 123,
          "orderedDashboards": [
            "<string>"
          ],
          "recentFilters": {},
          "recentQueries": {}
        },
        "name": "<string>",
        "options": {
          "companion": {
            "agentRuntimeRef": "<string>",
            "moduleRefs": [
              "<string>"
            ],
            "prompt": "<string>"
          },
          "dataOptions": [
            {
              "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>"
            }
          ],
          "dataProperties": {},
          "executionPolicy": {
            "backoffBaseSeconds": 123,
            "backoffStrategy": "<string>",
            "maxAttempts": 123,
            "onExhausted": "<string>",
            "timeoutSeconds": 123
          },
          "groupTaxonTypeFeatures": {},
          "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>"
            }
          ],
          "properties": {},
          "taskOptions": {
            "showNewTask": true,
            "showTakeNext": true
          },
          "taxonTypeFeatures": {}
        },
        "orgSlug": "<string>",
        "overviewMarkdown": "<string>",
        "provider": "<string>",
        "providerImageUrl": "<string>",
        "providerUrl": "<string>",
        "publicAccess": true,
        "ref": "<string>",
        "scheduledJobs": [
          {
            "active": true,
            "deleted": true,
            "description": "<string>",
            "modelRef": "<string>",
            "name": "<string>",
            "oldIdentifier": "<string>",
            "properties": {},
            "schedules": [
              {
                "cronExpression": "<string>",
                "id": "<string>",
                "type": "<string>"
              }
            ]
          }
        ],
        "slug": "<string>",
        "stores": [
          {
            "allowDataEditing": true,
            "deleteProtection": true,
            "description": "<string>",
            "documentProperties": {},
            "files": [
              {
                "metadata": {},
                "url": "<string>"
              }
            ],
            "hasImage": true,
            "highQualityPreview": true,
            "labelExpressions": {},
            "name": "<string>",
            "ref": "<string>",
            "showStoreInLabeling": true,
            "showThumbnails": true,
            "slug": "<string>",
            "storePurpose": "<string>",
            "storeType": "<string>",
            "templateRef": "<string>"
          }
        ],
        "tags": [
          {
            "color": "<string>",
            "label": "<string>"
          }
        ],
        "taskStatuses": [
          {
            "color": "<string>",
            "icon": "<string>",
            "label": "<string>",
            "locked": true,
            "oldIdentifier": "<string>",
            "slug": "<string>",
            "statusType": "TODO"
          }
        ],
        "taskTemplates": [
          {
            "description": "<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,
                  "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>",
            "oldIdentifier": "<string>",
            "planTemplate": {
              "items": [
                {
                  "agentModuleRefs": [
                    "<string>"
                  ],
                  "agentRuntimeId": "<string>",
                  "allowedOutcomes": [
                    "<string>"
                  ],
                  "approvalCriteria": {},
                  "approverRole": "<string>",
                  "badges": [
                    {
                      "color": "<string>",
                      "icon": "<string>",
                      "label": "<string>"
                    }
                  ],
                  "bridgeActions": [
                    {
                      "name": "<string>",
                      "uuid": "<string>"
                    }
                  ],
                  "condition": {},
                  "dependsOn": [
                    "<string>"
                  ],
                  "description": "<string>",
                  "disableCache": true,
                  "endpointName": "<string>",
                  "enrichment": [
                    {
                      "inputMapping": {},
                      "operation": "<string>",
                      "outputKey": "<string>",
                      "serviceBridgeRef": "<string>"
                    }
                  ],
                  "hideLock": true,
                  "includeDocument": {
                    "documentTypes": [
                      "<string>"
                    ],
                    "includeExtractedData": true,
                    "maxPages": 123
                  },
                  "joinPolicy": "<string>",
                  "llmModelName": "<string>",
                  "maxParallel": 123,
                  "maxStepsToInsert": 123,
                  "moduleRef": "<string>",
                  "name": "<string>",
                  "options": {},
                  "outputMapping": {},
                  "perDocument": true,
                  "plannerContext": {},
                  "position": {
                    "x": 123,
                    "y": 123
                  },
                  "prompt": "<string>",
                  "promptActions": [
                    {
                      "name": "<string>",
                      "uuid": "<string>"
                    }
                  ],
                  "promptBody": "<string>",
                  "promptTemplateRef": "<string>",
                  "promptVariables": {},
                  "requestBody": {},
                  "requestHeaders": {},
                  "requestPath": {},
                  "requestQuery": {},
                  "requestScript": "<string>",
                  "script": "<string>",
                  "scriptActions": [
                    {
                      "name": "<string>",
                      "uuid": "<string>"
                    }
                  ],
                  "scriptSidecars": [
                    "<string>"
                  ],
                  "serviceBridgeRef": "<string>",
                  "stepKey": "<string>",
                  "taskData": {
                    "actions": [
                      {
                        "label": "<string>",
                        "properties": {},
                        "type": "<string>",
                        "uuid": "<string>"
                      }
                    ],
                    "description": "<string>",
                    "documentFamilyGroups": [
                      {
                        "automaticallyAdd": true,
                        "documentFamilyFilter": "<string>",
                        "editable": true,
                        "hardMaxPages": 123,
                        "maxHits": 123,
                        "maxPages": 123,
                        "maxSize": 123,
                        "name": "<string>",
                        "notes": "<string>",
                        "sort": "<string>",
                        "titlePrompt": "<string>",
                        "uniqueFilenames": true,
                        "uploadOnly": true
                      }
                    ],
                    "forms": [
                      {
                        "actions": [
                          {
                            "label": "<string>",
                            "properties": {},
                            "type": "<string>",
                            "uuid": "<string>"
                          }
                        ],
                        "availablePanels": {},
                        "dataFormRef": "<string>",
                        "properties": {}
                      }
                    ],
                    "panelProperties": {},
                    "priority": 123,
                    "properties": {},
                    "title": "<string>"
                  },
                  "taskStatusSlug": "<string>",
                  "taskTemplateRef": "<string>",
                  "timeoutSeconds": 123,
                  "treatAsError": "<string>",
                  "type": "<string>",
                  "uuid": "<string>"
                }
              ]
            },
            "planned": true,
            "slug": "<string>"
          }
        ],
        "taxonomies": [
          {
            "description": "<string>",
            "name": "<string>",
            "ref": "<string>",
            "slug": "<string>",
            "taxonomyType": "<string>",
            "taxons": {},
            "templateRef": "<string>"
          }
        ],
        "template": true,
        "type": "<string>",
        "version": "<string>"
      },
      "name": "<string>",
      "organizationId": "<string>",
      "publicAccess": true,
      "slug": "<string>",
      "template": true,
      "type": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>",
      "yamlSource": "<string>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

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.

Query Parameters

​
page
integer<int32>

Page number (1-indexed). Defaults to 1.

​
pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

​
sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

​
filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

​
query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of ProjectTemplateMetadata

Paginated response containing ProjectTemplateMetadata items.

​
content
object[]

Array of ProjectTemplateMetadata items on this page.

​
first
boolean

Whether this is the first page.

​
last
boolean

Whether this is the last page.

​
number
integer<int32>

Current page number (0-indexed).

​
numberOfElements
integer<int32>

Number of items on the current page.

​
pageable
object

Pagination metadata.

​
size
integer<int32>

Page size (number of items per page).

​
sort
object

Sort metadata.

​
totalElements
integer<int64>

Total number of items across all pages.

​
totalPages
integer<int32>

Total number of pages.