Introduction
Organizations
Projects
- GETList Projects
- GETGet Project by ID
- GETList project assistants
- GETGet assistant event options
- GETList assistant executions
- GETGet assistant stores
- GETCreate project template request
- GETGet project dashboards
- GETList project data forms
- GETGet project guidance
- GETGet project resources
- GETGet Project change sequence
- POSTCreate Project
- POSTAdd assistant to project
- POSTSend assistant event
- POSTAdd data form to project
- PUTUpdate Project
- PUTUpdate project assistants
- PUTUpdate project assistant
- PUTActivate assistant
- PUTDeactivate assistant
- PUTTrigger assistant schedule
- PUTUpdate assistant stores
- PUTUpdate project resources
- DELDelete Project
- DELRemove assistant from project
Tasks
- GETList Tasks
- GETGet Task by ID
- GETGet Task change sequence
- POSTCreate Task
- POSTAssign next available task
- POSTCreate task with request
- POSTLock task
- POSTUnlock task
- PUTUpdate Task
- PUTUpdate task assignee
- PUTUpdate task status
- PUTUpdate Tasks Team
- DELDelete Task
- DELClear task assignee
- DELClear task status
- DELDelete Tasks Team
Document Families
- GETList DocumentFamilies
- GETGet DocumentFamily by ID
- GETGet applied knowledge sets
- GETExport document family data
- GETExport document family
- GETGet document family page image
- GETGet related knowledge items
- GETGet DocumentFamily change sequence
- GETTouch document family
- POSTCreate DocumentFamily
- POSTLink knowledge feature to document family
- POSTAssess document for knowledge
- POSTAdd a label to a document family
- POSTLock a document family
- POSTUpload new content
- POSTUnlink knowledge feature from document family
- POSTReprocess a document family
- POSTUnlock a document family
- PUTUpdate DocumentFamily
- PUTUpdate document family assignees
- PUTRename a document family
- PUTUpdate document family status
- DELDelete DocumentFamily
- DELRemove document family assignees
- DELRemove a label from a document family
Document Stores
Data Forms
Scheduled Jobs
Executions
Execution Slices
Step Executions
Knowledge Sets
Knowledge Items
- GETList Knowledge Items
- GETGet KnowledgeItem by ID
- GETDownload Knowledge Item Attachment
- GETGet Document Families for Knowledge Item
- GETGet KnowledgeItem change sequence
- POSTCreate KnowledgeItem
- POSTUpload Knowledge Item Attachment
- PUTUpdate KnowledgeItem
- DELDelete KnowledgeItem
- DELDelete Knowledge Item Attachment
Knowledge Features
- GETList Knowledge Features
- GETGet features by document family
- GETGet features by knowledge item
- GETGet KnowledgeFeature by ID
- GETGet KnowledgeFeature change sequence
- POSTCreate KnowledgeFeature
- POSTAssign Feature to Document Family
- POSTAssign Feature to Knowledge Item
- PUTUpdate KnowledgeFeature
- DELUnassign Feature from Document Family
- DELUnassign Feature from Knowledge Item
- DELDelete KnowledgeFeature
Knowledge Clauses
Applied Knowledge Sets
- GETList Applied Knowledge Sets
- GETGet outdated applied knowledge sets
- GETGet applied knowledge set statistics
- GETGet applied knowledge set snapshot
- GETGet AppliedKnowledgeSet by ID
- GETGet AppliedKnowledgeSet change sequence
- POSTCreate AppliedKnowledgeSet
- PUTUpdate AppliedKnowledgeSet
- DELDelete AppliedKnowledgeSet
Model Costs
Batch Updates
Agents
Agent Runtimes
Agent Sessions
Module Runtimes
Service Bridges
Project Resources
Teams
Resource Resolution
AccessTokens
Account
ActivityPlans
Applied Knowledge
AssistantConnection
Assistants
Channel
Content Exception
Content Object
Credit Transactions
Data Definitions
Data Stores
Document Assignments
Document Family Statistics
Document Statuses
Document Transitions
Events
Intakes
Job Document Family Interactions
Knowledge Clause Features
Knowledge Feature Types
Knowledge Item Types
Knowledge Set Snapshots
Knowledge Set Sources
Labels
Linked Deltas
Messages
Modules
Orchestrator Modules
Platform Configuration
Platform Overview
Product Groups
Product Overview
Product Subscriptions
ProductProjectTemplates
Project Status
Project Templates
Prompts
Purge Items
Recent Executions
Role Permissions
Roles
Scheduled Job Executions
Scheduled Job Schedules
Sessions
Tag Metadata
Task Statuses
TaskActivity
TaskDocumentFamilies
TaskTemplates
Team Members
Team Org Assignments
Team Project Assignments
Triggers
Users
Workspaces
AccessTokens
Account
ActivityPlans
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
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
- 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
Messages
Model Costs
Module Runtimes
Modules
Orchestrator Modules
Organizations
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
Sessions
Step Executions
Tag Metadata
TaskActivity
TaskDocumentFamilies
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
Create Prompts
curl --request POST \
--url https://platform.kodexa.ai/api/prompts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
}
'{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
}Prompts
Create Prompts
Creates a new Prompts. Prompts are templates used by AI assistants for document processing.
POST
/
api
/
prompts
Create Prompts
curl --request POST \
--url https://platform.kodexa.ai/api/prompts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<string>"
}
'{
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"deprecated": true,
"extensionPackRef": "<string>",
"id": "<string>",
"metadata": "aSDinaTvuI8gbWludGxpZnk=",
"name": "<string>",
"organizationId": "<string>",
"publicAccess": true,
"slug": "<string>",
"template": true,
"type": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>",
"yamlSource": "<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-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Body
application/json
Prompt metadata defines a prompt template used by AI assistants for document processing.
Optimistic locking version number.
Timestamp when the prompt was created.
Whether this prompt is deprecated.
Unique identifier (UUID) for the prompt.
Display name of the prompt.
Whether the prompt is publicly accessible.
URL-friendly identifier for the prompt.
Whether this prompt is a template.
Timestamp when the prompt was last updated.
Secondary UUID identifier.
Response
Created Prompts
Prompt metadata defines a prompt template used by AI assistants for document processing.
Optimistic locking version number.
Timestamp when the prompt was created.
Whether this prompt is deprecated.
Unique identifier (UUID) for the prompt.
Display name of the prompt.
Whether the prompt is publicly accessible.
URL-friendly identifier for the prompt.
Whether this prompt is a template.
Timestamp when the prompt was last updated.
Secondary UUID identifier.
⌘I