Introduction
AccessTokens
Account
Activities
ActivityDocumentFamilies
ActivityPlans
Agent Runtimes
Agent Sessions
Agents
Applied Knowledge
Applied Knowledge Sets
- GETList Applied Knowledge Sets
- POSTCreate AppliedKnowledgeSet
- GETGet outdated applied knowledge sets
- GETGet applied knowledge set statistics
- GETGet applied knowledge set snapshot
- GETGet AppliedKnowledgeSet by ID
- PUTUpdate AppliedKnowledgeSet
- DELDelete AppliedKnowledgeSet
- GETGet AppliedKnowledgeSet change sequence
AssistantConnection
Assistants
Batch Updates
Channel
Content Exception
Content Object
Credit Transactions
Data Definitions
Data Forms
Data Stores
Document Assignments
Document Family Statistics
Document Statuses
Document Stores
Document Transitions
DocumentFamilies
- GETList DocumentFamilies
- POSTCreate DocumentFamily
- GETGet DocumentFamily by ID
- PUTUpdate DocumentFamily
- DELDelete DocumentFamily
- POSTLink knowledge feature to document family
- GETGet applied knowledge sets
- POSTAssess document for knowledge
- PUTUpdate document family assignees
- DELRemove document family assignees
- GETExport document family data
- GETExport document family extracted data
- GETExport document family
- GETGet document family page image
- GETGet related knowledge items
- POSTAdd a label to a document family
- DELRemove a label from a document family
- POSTLock a document family
- GETDownload original native file
- POSTUpload new content
- POSTUnlink knowledge feature from document family
- PUTRename a document family
- POSTReprocess a document family
- GETGet DocumentFamily change sequence
- PUTUpdate document family status
- GETTouch document family
- POSTUnlock a document family
DocumentStores
Events
Execution Slices
Executions
- GETList Executions
- POSTCreate Execution
- DELClean execution cache
- PUTCancel a running execution
- GETDownload slice cache content
- POSTUpload slice cache content
- GETGet execution status messages
- POSTCreate execution status message
- GETGet Execution by ID
- PUTUpdate Execution
- DELDelete Execution
- PUTCancel execution
- GETGet Execution change sequence
- GETList execution status messages (legacy session route)
- POSTPost execution status message (legacy session route)
Intake
- POSTUpload via intake endpoint
- POSTAbort a multipart intake upload
- POSTComplete a multipart intake upload
- POSTGet presigned URLs for intake upload parts
- POSTInitiate a multipart intake upload
- POSTComplete a presigned upload via intake
- POSTRequest a presigned upload URL via intake
- GETList intake tokens
- POSTCreate intake token
- DELDelete intake token
Intakes
Job Document Family Interactions
Knowledge Clause Features
Knowledge Clauses
Knowledge Feature Types
Knowledge Features
- GETList Knowledge Features
- POSTCreate KnowledgeFeature
- POSTAssign feature to document family
- POSTAssign feature to knowledge item
- GETGet features by document family
- GETGet features by knowledge item
- DELUnassign feature from document family
- DELUnassign feature from knowledge item
- GETGet KnowledgeFeature by ID
- PUTUpdate KnowledgeFeature
- DELDelete KnowledgeFeature
- GETGet KnowledgeFeature change sequence
Knowledge Item Types
Knowledge Items
- GETList Knowledge Items
- POSTCreate KnowledgeItem
- GETGet KnowledgeItem by ID
- PUTUpdate KnowledgeItem
- DELDelete KnowledgeItem
- GETGet knowledge item attachment
- POSTUpload knowledge item attachment
- DELDelete knowledge item attachment
- GETGet document families for knowledge item
- GETGet KnowledgeItem change sequence
Knowledge Set Snapshots
Knowledge Set Sources
Knowledge Sets
- GETList Knowledge Sets
- POSTCreate KnowledgeSet
- GETGet knowledge sets by type
- GETGet KnowledgeSet by ID
- PUTUpdate KnowledgeSet
- DELDelete KnowledgeSet
- GETList knowledge set attachments
- POSTUpload knowledge set attachment
- GETDownload knowledge set attachment
- DELDelete knowledge set attachment
- GETGet KnowledgeSet change sequence
Labels
Linked Deltas
Messages
Model Costs
Module Runtimes
- POSTDeploy agent runtimes
- POSTUndeploy agent runtimes
- GETList Module Runtimes
- POSTCreate OrchestratorModuleRuntime
- POSTDeploy module runtimes
- POSTUndeploy module runtimes
- GETGet OrchestratorModuleRuntime by ID
- PUTUpdate OrchestratorModuleRuntime
- DELDelete OrchestratorModuleRuntime
- GETGet OrchestratorModuleRuntime change sequence
- GETGet module runtime statistics
Modules
Operations
Orchestrator Callbacks
Orchestrator Modules
Organizations
- GETList Organizations
- POSTCreate Organization
- GETGet Organization by ID
- PUTUpdate Organization
- DELDelete Organization
- GETList available modules
- GETList available project templates
- GETGet Organization change sequence
- GETList project templates available to an org
- GETGet organization labels
- POSTInvoke LLM
- GETGet organization members
- GETList secrets for an org
- POSTStore a secret for an org
- DELDelete an org secret
- GETReveal an org secret value
Platform Configuration
Platform Overview
Product Groups
Product Overview
Product Subscriptions
ProductProjectTemplates
Project Resources
Project Status
Project Templates
Projects
- GETList Projects
- POSTCreate Project
- GETGet Project by ID
- PUTUpdate Project
- DELDelete Project
- GETList project assistants
- POSTAdd assistant to project
- PUTUpdate project assistants
- PUTUpdate project assistant
- DELRemove assistant from project
- PUTActivate assistant
- PUTDeactivate assistant
- POSTSend assistant event
- GETGet assistant event options
- GETList assistant executions
- PUTTrigger assistant schedule
- GETGet assistant stores
- PUTUpdate assistant stores
- GETCreate project template request
- GETGet project dashboards
- GETList project data forms
- POSTAdd data form to project
- GETGet project guidance
- GETGet project resources
- PUTUpdate project resources
- GETGet Project change sequence
Prompts
Purge Items
Recent Executions
Resource Resolution
Role Permissions
Roles
Scheduled Job Executions
Scheduled Job Schedules
Scheduled Jobs
Service Bridges
- GETList Service Bridges
- POSTCreate ServiceBridgeMetadata
- GETGet ServiceBridgeMetadata by ID
- PUTUpdate ServiceBridgeMetadata
- DELDelete ServiceBridgeMetadata
- GETProxy request through a service bridge endpoint
- POSTProxy request through a service bridge endpoint
- PUTProxy request through a service bridge endpoint
- DELProxy request through a service bridge endpoint
- GETGet ServiceBridgeMetadata change sequence
Sessions
Step Executions
Tag Metadata
Task Groups
Task Statuses
TaskActivity
TaskDocumentFamilies
TaskGroupHistory
TaskTemplates
Tasks
- GETList Tasks
- POSTCreate Task
- POSTAssign next available task
- POSTCreate task with request
- GETGet Task by ID
- PUTUpdate Task
- DELDelete Task
- PUTUpdate task assignee
- DELClear task assignee
- POSTLock task
- GETGet Task change sequence
- PUTUpdate task status
- DELClear task status
- PUTUpdate task team
- DELClear task team
- POSTUnlock task
Team Members
Team Org Assignments
Team Project Assignments
Teams
Triggers
Users
Workspaces
AccessTokens
Account
Activities
- GETList Activities
- POSTStart an activity
- GETGet Activity by ID
- DELDelete Activity
- POSTCancel a running activity
- GETGet activity logs
- POSTReplan an activity
- POSTRetry a failed activity
- GETGet Activity change sequence
- PATCHUpdate an activity step
- POSTApprove a paused activity step
- GETList document family executions for an activity step
ActivityDocumentFamilies
ActivityPlans
Agent Runtimes
Module Runtimes
- POSTDeploy agent runtimes
- POSTUndeploy agent runtimes
- GETList Module Runtimes
- POSTCreate OrchestratorModuleRuntime
- GETGet OrchestratorModuleRuntime by ID
- PUTUpdate OrchestratorModuleRuntime
- DELDelete OrchestratorModuleRuntime
- GETGet OrchestratorModuleRuntime change sequence
- GETGet module runtime statistics
- POSTDeploy module runtimes
- POSTUndeploy module runtimes
Agent Sessions
Agents
Applied Knowledge Sets
- GETList Applied Knowledge Sets
- POSTCreate AppliedKnowledgeSet
- GETGet applied knowledge set snapshot
- GETGet AppliedKnowledgeSet by ID
- PUTUpdate AppliedKnowledgeSet
- DELDelete AppliedKnowledgeSet
- GETGet AppliedKnowledgeSet change sequence
- GETGet outdated applied knowledge sets
- GETGet applied knowledge set statistics
Applied Knowledge
AssistantConnection
Assistants
Batch Updates
Channel
Platform Overview
Content Exception
Content Object
Credit Transactions
Data Definitions
Data Forms
Data Stores
Document Assignments
DocumentFamilies
- GETList DocumentFamilies
- POSTCreate DocumentFamily
- GETGet DocumentFamily by ID
- PUTUpdate DocumentFamily
- DELDelete DocumentFamily
- POSTLink knowledge feature to document family
- GETGet applied knowledge sets
- POSTAssess document for knowledge
- PUTUpdate document family assignees
- DELRemove document family assignees
- GETExport document family data
- GETExport document family extracted data
- GETExport document family
- GETGet document family page image
- GETGet related knowledge items
- POSTAdd a label to a document family
- DELRemove a label from a document family
- POSTLock a document family
- GETDownload original native file
- POSTUpload new content
- POSTUnlink knowledge feature from document family
- PUTRename a document family
- POSTReprocess a document family
- GETGet DocumentFamily change sequence
- PUTUpdate document family status
- GETTouch document family
- POSTUnlock a document family
Document Family Statistics
Document Statuses
Document Stores
DocumentStores
Document Transitions
Events
Execution Slices
Executions
- GETList Executions
- POSTCreate Execution
- DELClean execution cache
- PUTCancel a running execution
- GETDownload slice cache content
- POSTUpload slice cache content
- GETGet execution status messages
- POSTCreate execution status message
- GETGet Execution by ID
- PUTUpdate Execution
- DELDelete Execution
- PUTCancel execution
- GETGet Execution change sequence
- GETList execution status messages (legacy session route)
- POSTPost execution status message (legacy session route)
Operations
Intake
- POSTUpload via intake endpoint
- POSTAbort a multipart intake upload
- POSTComplete a multipart intake upload
- POSTGet presigned URLs for intake upload parts
- POSTInitiate a multipart intake upload
- POSTComplete a presigned upload via intake
- POSTRequest a presigned upload URL via intake
- GETList intake tokens
- POSTCreate intake token
- DELDelete intake token
Intakes
Job Document Family Interactions
Knowledge Clause Features
Knowledge Clauses
Knowledge Feature Types
Knowledge Features
- GETList Knowledge Features
- POSTCreate KnowledgeFeature
- GETGet KnowledgeFeature by ID
- PUTUpdate KnowledgeFeature
- DELDelete KnowledgeFeature
- GETGet KnowledgeFeature change sequence
- POSTAssign feature to document family
- POSTAssign feature to knowledge item
- GETGet features by document family
- GETGet features by knowledge item
- DELUnassign feature from document family
- DELUnassign feature from knowledge item
Knowledge Item Types
Knowledge Items
- GETList Knowledge Items
- POSTCreate KnowledgeItem
- GETGet KnowledgeItem by ID
- PUTUpdate KnowledgeItem
- DELDelete KnowledgeItem
- GETGet knowledge item attachment
- POSTUpload knowledge item attachment
- DELDelete knowledge item attachment
- GETGet document families for knowledge item
- GETGet KnowledgeItem change sequence
Knowledge Set Snapshots
Knowledge Set Sources
Knowledge Sets
- GETList Knowledge Sets
- POSTCreate KnowledgeSet
- GETGet KnowledgeSet by ID
- PUTUpdate KnowledgeSet
- DELDelete KnowledgeSet
- GETList knowledge set attachments
- POSTUpload knowledge set attachment
- GETDownload knowledge set attachment
- DELDelete knowledge set attachment
- GETGet KnowledgeSet change sequence
- GETGet knowledge sets by type
Labels
Linked Deltas
Messages
Model Costs
Modules
Orchestrator Modules
Orchestrator Callbacks
Organizations
- GETList Organizations
- POSTCreate Organization
- GETGet Organization by ID
- PUTUpdate Organization
- DELDelete Organization
- GETList available modules
- GETList available project templates
- GETGet Organization change sequence
- GETList project templates available to an org
- GETGet organization labels
- POSTInvoke LLM
- GETGet organization members
- GETList secrets for an org
- POSTStore a secret for an org
- DELDelete an org secret
- GETReveal an org secret value
Platform Configuration
Product Groups
ProductProjectTemplates
Product Subscriptions
Product Overview
Project Resources
Project Status
Project Templates
Projects
- GETList Projects
- POSTCreate Project
- GETGet Project by ID
- PUTUpdate Project
- DELDelete Project
- GETList project assistants
- PUTUpdate project assistants
- POSTAdd assistant to project
- PUTUpdate project assistant
- DELRemove assistant from project
- PUTActivate assistant
- PUTDeactivate assistant
- POSTSend assistant event
- GETGet assistant event options
- GETList assistant executions
- PUTTrigger assistant schedule
- GETGet assistant stores
- PUTUpdate assistant stores
- GETCreate project template request
- GETGet project dashboards
- GETList project data forms
- POSTAdd data form to project
- GETGet project guidance
- GETGet project resources
- PUTUpdate project resources
- GETGet Project change sequence
Prompts
Purge Items
Recent Executions
Resource Resolution
Role Permissions
Roles
Scheduled Job Executions
Scheduled Job Schedules
Scheduled Jobs
Service Bridges
- GETList Service Bridges
- POSTCreate ServiceBridgeMetadata
- GETGet ServiceBridgeMetadata by ID
- PUTUpdate ServiceBridgeMetadata
- DELDelete ServiceBridgeMetadata
- GETProxy request through a service bridge endpoint
- PUTProxy request through a service bridge endpoint
- POSTProxy request through a service bridge endpoint
- DELProxy request through a service bridge endpoint
- PATCHProxy request through a service bridge endpoint
- GETGet ServiceBridgeMetadata change sequence
Sessions
Step Executions
Tag Metadata
TaskActivity
TaskDocumentFamilies
TaskGroupHistory
Task Groups
Task Statuses
TaskTemplates
Tasks
- GETList Tasks
- POSTCreate Task
- GETGet Task by ID
- PUTUpdate Task
- DELDelete Task
- PUTUpdate task assignee
- DELClear task assignee
- POSTLock task
- GETGet Task change sequence
- PUTUpdate task status
- DELClear task status
- PUTUpdate task team
- DELClear task team
- POSTUnlock task
- POSTAssign next available task
- POSTCreate task with request
Team Members
Team Org Assignments
Team Project Assignments
Teams
Triggers
Users
Check if user is admin
curl --request GET \
--url https://platform.kodexa.ai/api/account/admin \
--header 'x-api-key: <api-key>'trueAccount
Check if user is admin
Returns whether the currently authenticated user has platform admin privileges.
GET
/
api
/
account
/
admin
Check if user is admin
curl --request GET \
--url https://platform.kodexa.ai/api/account/admin \
--header 'x-api-key: <api-key>'trueDocumentation 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-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Response
Admin status
The response is of type boolean.
⌘I