Create DocumentStores - Kodexa Developer Portal

curl --request POST \ --url https://platform.kodexa.ai/api/document-stores \ --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": "c2345678-90ab-cdef-1234-567890abcdef", "metadata": "aSDinaTvuI8gbWludGxpZnk=", "name": "Invoice Store", "publicAccess": true, "slug": "invoice-store", "storeType": "DOCUMENT", "supportsScheduling": true, "template": true, "updatedOn": "2023-11-07T05:31:56Z", "uuid": "<string>", "version": "1.0.0" } '

{ "changeSequence": 123, "createdOn": "2023-11-07T05:31:56Z", "deprecated": true, "eventAware": true, "extensionPackRef": "<string>", "id": "c2345678-90ab-cdef-1234-567890abcdef", "metadata": "aSDinaTvuI8gbWludGxpZnk=", "name": "Invoice Store", "publicAccess": true, "slug": "invoice-store", "storeType": "DOCUMENT", "supportsScheduling": true, "template": true, "updatedOn": "2023-11-07T05:31:56Z", "uuid": "<string>", "version": "1.0.0" }

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

Store metadata describes a document store — a container for organizing and processing documents.

changeSequence

integer<int32>

Optimistic locking version number.

createdOn

string<date-time>

Timestamp when the store was created.

deprecated

boolean

Whether this store is deprecated.

eventAware

boolean | null

Whether the store emits events on changes.

extensionPackRef

string

Reference to the extension pack.

string

Unique identifier (UUID) for the store.

Example:

"c2345678-90ab-cdef-1234-567890abcdef"

metadata

string<byte>

Store-specific configuration metadata.

name

string

Display name of the document store.

Example:

"Invoice Store"

publicAccess

boolean

Whether the store is publicly accessible.

slug

string

URL-friendly identifier for the store.

Example:

"invoice-store"

storeType

string

Type of the store (e.g., DOCUMENT, DATA).

Example:

"DOCUMENT"

supportsScheduling

boolean | null

Whether the store supports scheduled processing.

template

boolean

Whether this store is a template.

updatedOn

string<date-time>

Timestamp when the store was last updated.

uuid

string

Secondary UUID identifier.

version

string

Semantic version string (e.g., '1.0.0').

Example:

"1.0.0"

Response

Created DocumentStores

Store metadata describes a document store — a container for organizing and processing documents.

changeSequence

integer<int32>

Optimistic locking version number.

createdOn

string<date-time>

Timestamp when the store was created.

deprecated

boolean

Whether this store is deprecated.

eventAware

boolean | null

Whether the store emits events on changes.

extensionPackRef

string

Reference to the extension pack.

string

Unique identifier (UUID) for the store.

Example:

"c2345678-90ab-cdef-1234-567890abcdef"

metadata

string<byte>

Store-specific configuration metadata.

name

string

Display name of the document store.

Example:

"Invoice Store"

publicAccess

boolean

Whether the store is publicly accessible.

slug

string

URL-friendly identifier for the store.

Example:

"invoice-store"

storeType

string

Type of the store (e.g., DOCUMENT, DATA).

Example:

"DOCUMENT"

supportsScheduling

boolean | null

Whether the store supports scheduled processing.

template

boolean

Whether this store is a template.

updatedOn

string<date-time>

Timestamp when the store was last updated.

uuid

string

Secondary UUID identifier.

version

string

Semantic version string (e.g., '1.0.0').

Example:

"1.0.0"

Introduction

Organizations

Projects

Tasks

Document Families

Document Stores

Taxonomies

Assistants

Data Forms

Data Exceptions

Content Objects

Scheduled Jobs

Extension Packs

Executions

Dashboards

Guidance

Notes

Knowledge

Embeddings & Model Costs

Batch Updates

Account & Users

Platform

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

Document Family Statistics

Document Statuses

Document Stores

Document Transitions

Embeddings

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