Skip to main content
Kodexa Developer Portal home page
Search...
⌘K
Support
Search...
Navigation
Page Not Found
Welcome
Concepts
Getting Started
CLI
Guides
API Reference
Kodexa
Support
Introduction
API Reference
Tasks
GET
Get a resource with the provided ID
PUT
Update the given instance
DEL
Delete the resource with the provided ID
PUT
Update the status of the task
DEL
Remove the task status
PUT
Update the assignee of the task
DEL
Remove the task assignee
GET
Get the entity metadata for the filter
POST
Create a new instance of the resource
POST
Create a new task with the given request (to include document families)
Projects
GET
Get a resource with the provided ID
PUT
Update the given instance
DEL
Delete the project with the provided ID and its associated resources
GET
Get the tags on a project
PUT
Update the tags on a project
GET
Get the project resources
PUT
Update all the resources associated with this project
GET
Paginated list of assistants that have been added to this project
PUT
Update the assistant in the given project
POST
Create and add assistant to project
PUT
Update the assistant in the given project
DEL
Delete specified assistant
GET
List the assistant stores specified assistant
PUT
Update the list of stores for an assistant
PUT
Send a schedule event now to this assistant
PUT
Deactivate the assistant (stopping it from getting content events)
PUT
Activate the assistant (ensuring it gets content events)
GET
Get a list of the data forms associated with this project
POST
Add a dataform to the project
POST
Send a document to upload and send as an event to an assistant
GET
Get the task tags for the project
GET
Get the notes for the project
GET
Get a list of the stores (type data) associated with this project
GET
Create a project template request
GET
Paginated list of assistant executions
GET
Get event handler options for an assistant
Assistants
GET
Get an assistant memory key
PUT
Create or update a key memory for the assistant
DocumentFamilies
Document Families Overview
GET
Get a resource with the provided ID
PUT
Update the given instance
DEL
Delete the resource with the provided ID
GET
Get the external data for a document family
PUT
Update the external data for a document family
GET
Get the entity metadata for the filter
POST
Create a new instance of the resource
GET
Touching a document family triggers a DocumentFamilyEvent without changing the document family
Taxonomies
GET
Get taxonomy by slug
PUT
Update taxonomy
DEL
Delete taxonomy
GET
Get taxonomy by version
PUT
Update taxonomy version
DEL
Delete taxonomy version
GET
List all taxonomies
POST
Create new taxonomy
GET
List taxonomies for organization
POST
Suggest taxonomy taxon
GET
Get taxonomy sequence
GET
Export taxonomy
Stores
Stores API Overview
GET
Download file from store
Get document metadata
Upload document to store
PUT
Rename the document family
Delete document from store
Organizations
GET
Get the available templates for the organization
GET
Get the available model for the organization
GET
Get the available model for the organization
Executions
PUT
Cancel the specific execution
Data Forms
GET
Get data form by slug
PUT
Update data form
DEL
Delete data form
GET
List data forms for organization
POST
Create new data form
GET
List all data forms
GET
Get a resource with the provided ID
PUT
Update the given instance
DEL
Delete the resource with the provided ID
GET
Get the entity metadata for the filter
POST
Create a new instance of the resource
Account & User
GET
Get my user profile information
PUT
Update my profile information
GET
Get memberships for user
404
Page Not Found
We couldn't find the page. Maybe you were looking for one of these pages below?
API Reference
Document Stores
Document Families Overview
⌘I