List Applied Knowledge Sets
curl --request GET \
--url https://platform.kodexa.ai/api/applied-knowledge-sets \
--header 'x-api-key: <api-key>'import requests
url = "https://platform.kodexa.ai/api/applied-knowledge-sets"
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/applied-knowledge-sets', 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/applied-knowledge-sets",
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/applied-knowledge-sets"
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/applied-knowledge-sets")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/applied-knowledge-sets")
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{
"content": [
{
"appliedAt": "2023-11-07T05:31:56Z",
"appliedBy": "<string>",
"changeSequence": 123,
"confidence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"documentFamily": {
"changeSequence": 123,
"contentObjects": [
{
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": [
"<string>"
],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleted": true,
"deletedDate": "2023-11-07T05:31:56Z",
"documentStatus": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"executionTargets": {
"instances": [
{
"actor": {
"actorId": "<string>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
]
}
]
},
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"locked": true,
"metadata": {},
"metadataSource": {},
"modified": "2023-11-07T05:31:56Z",
"originalPath": "<string>",
"path": "invoices/2025/q4/invoice-001.pdf",
"pendingProcessing": true,
"size": 245760,
"statistics": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"recentExecutions": [
{
"assistant": {
"active": true,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": true,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": [
"<string>"
],
"pipeline": {
"steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
]
},
"prompt": "<string>",
"taxonomies": [
"<string>"
]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<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
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": true,
"showInTraining": true,
"slug": "invoice-extractor",
"subscription": "<string>",
"testOptions": {},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"validationErrors": {
"instances": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"execution": {
"assistantId": "<string>",
"changeSequence": 123,
"context": {},
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"statusDetails": {
"detail": "<string>",
"message": "<string>",
"progress": 123,
"progressMax": 123,
"stepStatus": "<string>"
},
"targets": {
"instances": [
{
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
],
"type": "<string>"
}
]
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"id": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"documentFamilyId": "<string>",
"id": "<string>",
"knowledgeSetId": "<string>",
"snapshot": {
"changeReason": "<string>",
"changeSequence": 123,
"contentHash": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"data": "<unknown>",
"id": "<string>",
"knowledgeSetId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": 123
},
"snapshotId": "<string>",
"sourceContentObjectId": "<string>",
"status": "<string>",
"supersededAt": "2023-11-07T05:31:56Z",
"supersededById": "<string>",
"trigger": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<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
}Applied Knowledge Sets
List Applied Knowledge Sets
Returns a paginated list of Applied Knowledge Sets. Applied knowledge set configurations determine which knowledge is available during processing.
GET
/
api
/
applied-knowledge-sets
List Applied Knowledge Sets
curl --request GET \
--url https://platform.kodexa.ai/api/applied-knowledge-sets \
--header 'x-api-key: <api-key>'import requests
url = "https://platform.kodexa.ai/api/applied-knowledge-sets"
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/applied-knowledge-sets', 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/applied-knowledge-sets",
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/applied-knowledge-sets"
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/applied-knowledge-sets")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/applied-knowledge-sets")
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{
"content": [
{
"appliedAt": "2023-11-07T05:31:56Z",
"appliedBy": "<string>",
"changeSequence": 123,
"confidence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"documentFamily": {
"changeSequence": 123,
"contentObjects": [
{
"changeSequence": 123,
"contentMetadata": {},
"contentType": 123,
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"docTransitionType": "<string>",
"documentFamilyId": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"documentVersion": "<string>",
"id": "<string>",
"index": 123,
"metadata": {},
"mixins": [
"<string>"
],
"modified": "2023-11-07T05:31:56Z",
"name": "<string>",
"size": 123,
"source": {
"checksum": "<string>",
"cid": "<string>",
"connector": "<string>",
"created": "<string>",
"document_family_id": "<string>",
"headers": {},
"last_modified": "<string>",
"lineage_document_uuid": "<string>",
"mime_type": "<string>",
"original_filename": "<string>",
"original_path": "<string>",
"source_document_uuid": "<string>"
},
"sourceContentObjectId": "<string>",
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"created": "2023-11-07T05:31:56Z",
"createdOn": "2023-11-07T05:31:56Z",
"deleteUserEmail": "<string>",
"deleted": true,
"deletedDate": "2023-11-07T05:31:56Z",
"documentStatus": "<string>",
"documentTaxonValidations": [
{
"taxonPath": "<string>",
"taxonomyRef": "<string>",
"validation": {
"conditional": true,
"conditionalFormula": "<string>",
"description": "<string>",
"detailFormula": "<string>",
"disabled": true,
"exceptionId": "<string>",
"messageFormula": "<string>",
"name": "<string>",
"overridable": true,
"ruleFormula": "<string>",
"supportArticleId": "<string>"
}
}
],
"executionTargets": {
"instances": [
{
"actor": {
"actorId": "<string>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
]
}
]
},
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"locked": true,
"metadata": {},
"metadataSource": {},
"modified": "2023-11-07T05:31:56Z",
"originalPath": "<string>",
"path": "invoices/2025/q4/invoice-001.pdf",
"pendingProcessing": true,
"size": 245760,
"statistics": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"recentExecutions": [
{
"assistant": {
"active": true,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": true,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": [
"<string>"
],
"pipeline": {
"steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
]
},
"prompt": "<string>",
"taxonomies": [
"<string>"
]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<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
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<string>"
]
},
"showDeveloperTools": true,
"title": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"userStorage": {
"favoriteLinks": [
{
"link": "<string>"
}
]
},
"userType": "<string>",
"uuid": "<string>"
},
"ownerId": "<string>",
"projectTemplateRef": "<string>",
"searchText": "<string>",
"slug": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": true,
"showInTraining": true,
"slug": "invoice-extractor",
"subscription": "<string>",
"testOptions": {},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"validationErrors": {
"instances": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"execution": {
"assistantId": "<string>",
"changeSequence": 123,
"context": {},
"createdOn": "2023-11-07T05:31:56Z",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"statusDetails": {
"detail": "<string>",
"message": "<string>",
"progress": 123,
"progressMax": 123,
"stepStatus": "<string>"
},
"targets": {
"instances": [
{
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
],
"type": "<string>"
}
]
},
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"id": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"documentFamilyId": "<string>",
"id": "<string>",
"knowledgeSetId": "<string>",
"snapshot": {
"changeReason": "<string>",
"changeSequence": 123,
"contentHash": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"data": "<unknown>",
"id": "<string>",
"knowledgeSetId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": 123
},
"snapshotId": "<string>",
"sourceContentObjectId": "<string>",
"status": "<string>",
"supersededAt": "2023-11-07T05:31:56Z",
"supersededById": "<string>",
"trigger": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<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
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Query Parameters
Page number (1-indexed). Defaults to 1.
Number of items per page (1-1000). Defaults to 20, maximum 1000.
Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.
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
Full-text search query matching against the entity's searchable fields.
Response
Page of AppliedKnowledgeSet
Paginated response containing AppliedKnowledgeSet items.
Array of AppliedKnowledgeSet items on this page.
Show child attributes
Show child attributes
Whether this is the first page.
Whether this is the last page.
Current page number (0-indexed).
Number of items on the current page.
Pagination metadata.
Show child attributes
Show child attributes
Page size (number of items per page).
Sort metadata.
Show child attributes
Show child attributes
Total number of items across all pages.
Total number of pages.
⌘I