Introduction
Organizations
Projects
- GETList Projects
- POSTCreate Project
- GETGet Project by ID
- PUTUpdate Project
- DELDelete Project
- GETGet project resources
- PUTUpdate project resources
- GETList project assistants
- POSTAdd assistant to project
- PUTUpdate project assistants
- PUTUpdate project assistant
- DELRemove assistant from project
- GETGet assistant stores
- PUTUpdate assistant stores
- PUTTrigger assistant schedule
- PUTActivate assistant
- PUTDeactivate assistant
- POSTSend assistant event
- GETGet assistant event options
- GETList assistant executions
- GETList project data forms
- POSTAdd data form to project
- GETGet project guidance
- GETGet project notes
- GETGet project dashboards
- GETCreate project template request
Tasks
Document Families
- Document Families Overview
- GETList DocumentFamilies
- POSTCreate DocumentFamily
- GETGet DocumentFamily by ID
- PUTUpdate DocumentFamily
- DELDelete DocumentFamily
- POSTLock a document family
- POSTUnlock a document family
- POSTAdd a label to a document family
- DELRemove a label from a document family
- PUTUpdate document family assignees
- DELRemove document family assignees
- PUTUpdate document family status
- PUTRename a document family
- POSTReprocess a document family
- GETGet document family page image
- POSTUpload new content
- GETGet external data
- PUTUpdate external data
- GETTouch document family
- GETExport document family data
- GETExport document family
- POSTAdd knowledge feature
- POSTRemove knowledge feature
- POSTAssess document for knowledge
- GETGet related knowledge items
- GETGet applied knowledge sets
Document Stores
Assistants
Data Forms
Content Objects
Scheduled Jobs
Executions
Knowledge Sets
Knowledge Items
Knowledge Features
- GETList Knowledge Features
- POSTCreate KnowledgeFeature
- GETGet KnowledgeFeature by ID
- PUTUpdate KnowledgeFeature
- DELDelete KnowledgeFeature
- GETGet Features by Document Family
- GETGet Features by Knowledge Item
- POSTAssign Feature to Document Family
- DELUnassign Feature from Document Family
- POSTAssign Feature to Knowledge Item
- DELUnassign Feature from Knowledge Item
Knowledge Clauses
Applied Knowledge Sets
Knowledge Configuration
Embeddings & Model Costs
Batch Updates
Account & Users
AccessTokens
Account
Agent 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
Cloud Models
Platform Overview
Content Exception
Content Object
Credit Transactions
Data Definitions
Data Forms
Data Stores
Document Assignments
Document External Data
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
- GETGet external data
- PUTUpdate external data
- 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
- 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
Document Transitions
Events
Execution Slices
Executions
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
Labels
Linked Deltas
Memberships
Messages
Model Costs
Module Runtimes
Module Versions
Modules
Orchestrator Content Objects
Orchestrator Modules
Secrets
Organizations
Permissions
Pipeline Executions
Pipeline Steps
Pipeline Triggers
Pipeline Versions
Pipelines
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
Sessions
Step Executions
Orchestrator Stores
Tag Metadata
TaskActivity
TaskDocumentFamilies
Task Statuses
TaskTemplates
Tasks
Team Members
Team Org Assignments
Team Project Assignments
Teams
Users
Create Modules
Copy
Ask AI
curl --request POST \
--url https://platform.kodexa.ai/api/modules \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": "<string>"
}
'Copy
Ask AI
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": "<string>"
}Modules
Create Modules
Creates a new Modules. Modules are processing modules that can be executed on documents.
POST
/
api
/
modules
Create Modules
Copy
Ask AI
curl --request POST \
--url https://platform.kodexa.ai/api/modules \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": "<string>"
}
'Copy
Ask AI
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"eventAware": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organization": {
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"slug": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"supportsScheduling": true,
"template": true,
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"version": "<string>"
}Authorizations
x-api-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Show child attributes
Show child attributes
Response
Created Modules
Show child attributes
Show child attributes