Introduction
Organizations
- GETList Organizations
- POSTCreate Organization
- GETGet Organization by ID
- PUTUpdate Organization
- DELDelete Organization
- GETList available assistants
- GETList available models
- GETList available templates
- PUTSuspend an organization
- GETGet organization labels
- GETGet organization members
- GETGet organization memberships
Projects
- GETList Projects
- POSTCreate Project
- GETGet Project by ID
- PUTUpdate Project
- DELDelete Project
- GETGet project tags
- PUTUpdate project tags
- 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 task tags
- 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
- 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
Taxonomies
Assistants
Data Forms
Data Exceptions
Content Objects
Scheduled Jobs
Extension Packs
Executions
Dashboards
Guidance
Knowledge
Embeddings & Model Costs
Batch Updates
Account & Users
AccessTokens
Account
Applied Knowledge Sets
Applied Knowledge
AssistantConnection
Assistants
Batch Updates
Channel
Cloud Models
Platform Overview
Content Exception
Content Object
Credit Transactions
Dashboards
DataAttributes
Data Definitions
Data Forms
DataObjects
Data Stores
Document Assignments
Document External Data
DocumentFamilies
- GETList DocumentFamilies
- POSTCreate DocumentFamily
- GETGet DocumentFamily by ID
- PUTUpdate DocumentFamily
- DELDelete DocumentFamily
- POSTAdd knowledge feature
- 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 related knowledge items
- POSTAdd a label to a document family
- DELRemove a label from a document family
- POSTLock a document family
- POSTUpload new content
- POSTRemove knowledge feature
- 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
Data Exceptions
Executions
Extension Packs
Guidance
Intakes
Job Document Family Interactions
Knowledge Clause Features
Knowledge Clauses
Knowledge Feature Types
Knowledge Features
Knowledge Item Types
Knowledge Items
Knowledge Set Snapshots
Knowledge Set Sources
Knowledge Sets
Labels
Linked Deltas
Memberships
Messages
Model Costs
Module Runtimes
Notes
Orchestrator Agent Runtimes
Orchestrator Agent Sessions
Orchestrator Content Objects
Orchestrator Execution Slices
Orchestrator Module Runtimes
Orchestrator Module Versions
Orchestrator Modules
Orchestrator Pipeline Executions
Orchestrator Pipeline Steps
Orchestrator Pipeline Triggers
Orchestrator Pipeline Versions
Orchestrator Pipelines
Orchestrator Step Executions
Orchestrator Stores
Secrets
Organizations
Platform Configuration
Product Groups
ProductProjectTemplates
Product Subscriptions
Product Overview
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 notes
- GETGet project resources
- PUTUpdate project resources
- GETGet Project change sequence
Prompts
Purge Items
Recent Executions
Scheduled Job Executions
Scheduled Job Schedules
Scheduled Jobs
Sessions
Tag Metadata
TaskActivity
TaskDocumentFamilies
Task Statuses
TaskTemplates
Tasks
Taxonomies
Team Members
Teams
Users
curl --request PUT \
--url https://platform.kodexa.ai/api/document-families/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
"changeSequence": 123,
"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>",
"actorType": "<string>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
],
"type": "<string>"
}
]
},
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"labelStatistics": {
"averageLabelConfidence": {},
"labelCounts": {},
"maxLabelConfidence": {},
"minLabelConfidence": {}
},
"locked": true,
"metadata": {},
"metadataSource": {},
"modified": "2023-11-07T05:31:56Z",
"numberOfContentExceptions": 123,
"numberOfInsights": 123,
"numberOfNotes": 123,
"originalPath": "<string>",
"path": "invoices/2025/q4/invoice-001.pdf",
"pendingProcessing": true,
"size": 245760,
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'{
"activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
"changeSequence": 123,
"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>",
"actorType": "<string>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
],
"type": "<string>"
}
]
},
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"labelStatistics": {
"averageLabelConfidence": {},
"labelCounts": {},
"maxLabelConfidence": {},
"minLabelConfidence": {}
},
"locked": true,
"metadata": {},
"metadataSource": {},
"modified": "2023-11-07T05:31:56Z",
"numberOfContentExceptions": 123,
"numberOfInsights": 123,
"numberOfNotes": 123,
"originalPath": "<string>",
"path": "invoices/2025/q4/invoice-001.pdf",
"pendingProcessing": true,
"size": 245760,
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Update DocumentFamily
Updates an existing DocumentFamily. Document families group related content objects representing a single logical document.
curl --request PUT \
--url https://platform.kodexa.ai/api/document-families/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
"changeSequence": 123,
"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>",
"actorType": "<string>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
],
"type": "<string>"
}
]
},
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"labelStatistics": {
"averageLabelConfidence": {},
"labelCounts": {},
"maxLabelConfidence": {},
"minLabelConfidence": {}
},
"locked": true,
"metadata": {},
"metadataSource": {},
"modified": "2023-11-07T05:31:56Z",
"numberOfContentExceptions": 123,
"numberOfInsights": 123,
"numberOfNotes": 123,
"originalPath": "<string>",
"path": "invoices/2025/q4/invoice-001.pdf",
"pendingProcessing": true,
"size": 245760,
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
'{
"activeAssistant": "aSDinaTvuI8gbWludGxpZnk=",
"changeSequence": 123,
"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>",
"actorType": "<string>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
],
"type": "<string>"
}
]
},
"id": "b1234567-89ab-cdef-0123-456789abcdef",
"labelStatistics": {
"averageLabelConfidence": {},
"labelCounts": {},
"maxLabelConfidence": {},
"minLabelConfidence": {}
},
"locked": true,
"metadata": {},
"metadataSource": {},
"modified": "2023-11-07T05:31:56Z",
"numberOfContentExceptions": 123,
"numberOfInsights": 123,
"numberOfNotes": 123,
"originalPath": "<string>",
"path": "invoices/2025/q4/invoice-001.pdf",
"pendingProcessing": true,
"size": 245760,
"storeRef": "<string>",
"summary": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}Authorizations
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
A document family groups related content objects representing a single logical document, tracking its processing lifecycle.
The assistant currently processing this document.
Optimistic locking version number.
Original file creation date.
Timestamp when the document family was created.
Email of the user who deleted the document family.
Whether the document family has been soft-deleted.
Timestamp when the document family was soft-deleted.
Current processing status of the document.
Validation results against the document taxonomy.
Show child attributes
Show child attributes
Processing execution targets for this document.
Show child attributes
Show child attributes
Unique identifier (UUID) for the document family.
"b1234567-89ab-cdef-0123-456789abcdef"
Statistics about labels applied to this document.
Show child attributes
Show child attributes
Whether the document family is locked for processing.
Document metadata extracted during processing.
Show child attributes
Show child attributes
Maps metadata keys to their source content object IDs.
Show child attributes
Show child attributes
Original file modification date.
Count of content processing exceptions.
Count of insights generated from this document.
Count of notes attached to this document family.
Original path before soft-deletion or rename.
File path or name of the document.
"invoices/2025/q4/invoice-001.pdf"
Whether the document family is queued for processing.
File size in bytes.
245760
Reference to the document store containing this document family.
AI-generated summary of the document content.
Timestamp when the document family was last updated.
Secondary UUID identifier.
Response
Updated DocumentFamily
A document family groups related content objects representing a single logical document, tracking its processing lifecycle.
The assistant currently processing this document.
Optimistic locking version number.
Original file creation date.
Timestamp when the document family was created.
Email of the user who deleted the document family.
Whether the document family has been soft-deleted.
Timestamp when the document family was soft-deleted.
Current processing status of the document.
Validation results against the document taxonomy.
Show child attributes
Show child attributes
Processing execution targets for this document.
Show child attributes
Show child attributes
Unique identifier (UUID) for the document family.
"b1234567-89ab-cdef-0123-456789abcdef"
Statistics about labels applied to this document.
Show child attributes
Show child attributes
Whether the document family is locked for processing.
Document metadata extracted during processing.
Show child attributes
Show child attributes
Maps metadata keys to their source content object IDs.
Show child attributes
Show child attributes
Original file modification date.
Count of content processing exceptions.
Count of insights generated from this document.
Count of notes attached to this document family.
Original path before soft-deletion or rename.
File path or name of the document.
"invoices/2025/q4/invoice-001.pdf"
Whether the document family is queued for processing.
File size in bytes.
245760
Reference to the document store containing this document family.
AI-generated summary of the document content.
Timestamp when the document family was last updated.
Secondary UUID identifier.