Skip to main content
POST
Create Project

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Body

application/json

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

changeSequence
integer<int32>

Optimistic locking version number.

color
string

Display color for the project (max 25 characters).

Example:

"#4A90D9"

createdOn
string<date-time>

Timestamp when the project was created.

dataFlow
object

Project data flow configuration.

description
string

Human-readable description of the project.

Example:

"Automated invoice processing pipeline."

documentStatuses
object[]
id
string

Unique identifier (UUID) for the project.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

memory
object

Project-level memory and configuration.

name
string

Display name of the project.

Example:

"Invoice Processing"

notes
string

Free-form notes about the project.

options
object

Project options and settings.

organization
object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

organizationId
string | null

ID of the organization this project belongs to.

owner
object | null

A platform user represents a user account in the Kodexa platform.

ownerId
string | null

ID of the user who owns this project.

projectTemplateRef
string

Reference to the project template used to create this project.

searchText
string
slug
string

URL-friendly identifier. Automatically lowercased. Pattern: ^[a-z0-9-]+$

Example:

"invoice-processing"

status
object | null

A project status defines a named state for tracking project lifecycle.

statusId
string | null

ID of the current project status.

statusType
string

Project lifecycle state: ACTIVE, ARCHIVED, or PENDING_DELETE.

Example:

"ACTIVE"

templateArticleId
string
updatedOn
string<date-time>

Timestamp when the project was last updated.

uuid
string

Secondary UUID identifier.

Example:

"7c9e667974254de944be07fc1f90ae7"

Response

Created Project

A project groups related document stores, assistants, tasks, and processing pipelines within an organization.

changeSequence
integer<int32>

Optimistic locking version number.

color
string

Display color for the project (max 25 characters).

Example:

"#4A90D9"

createdOn
string<date-time>

Timestamp when the project was created.

dataFlow
object

Project data flow configuration.

description
string

Human-readable description of the project.

Example:

"Automated invoice processing pipeline."

documentStatuses
object[]
id
string

Unique identifier (UUID) for the project.

Example:

"7c9e6679-7425-40de-944b-e07fc1f90ae7"

memory
object

Project-level memory and configuration.

name
string

Display name of the project.

Example:

"Invoice Processing"

notes
string

Free-form notes about the project.

options
object

Project options and settings.

organization
object | null

An organization is the top-level tenant in Kodexa. All projects, stores, and resources belong to an organization.

organizationId
string | null

ID of the organization this project belongs to.

owner
object | null

A platform user represents a user account in the Kodexa platform.

ownerId
string | null

ID of the user who owns this project.

projectTemplateRef
string

Reference to the project template used to create this project.

searchText
string
slug
string

URL-friendly identifier. Automatically lowercased. Pattern: ^[a-z0-9-]+$

Example:

"invoice-processing"

status
object | null

A project status defines a named state for tracking project lifecycle.

statusId
string | null

ID of the current project status.

statusType
string

Project lifecycle state: ACTIVE, ARCHIVED, or PENDING_DELETE.

Example:

"ACTIVE"

templateArticleId
string
updatedOn
string<date-time>

Timestamp when the project was last updated.

uuid
string

Secondary UUID identifier.

Example:

"7c9e667974254de944be07fc1f90ae7"