Skip to main content
POST
/
api
/
document-stores
/
{id}
/
upload
Upload file to document store
curl --request POST \
  --url https://platform.kodexa.ai/api/document-stores/{id}/upload \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form file='@example-file'
{
  "changeSequence": 123,
  "contentObjects": [
    {
      "changeSequence": 123,
      "contentMetadata": {},
      "contentType": "<string>",
      "created": "2023-11-07T05:31:56Z",
      "createdOn": "2023-11-07T05:31:56Z",
      "docTransitionType": "<string>",
      "documentFamilyId": "<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>"
          }
        }
      ],
      "documentVersion": "<string>",
      "id": "b1234567-89ab-cdef-0123-456789abcdef",
      "index": 123,
      "metadata": {},
      "mixins": [
        "<string>"
      ],
      "modified": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "size": 245760,
      "source": {
        "checksum": "<string>",
        "cid": "<string>",
        "connector": "<string>",
        "created": "<string>",
        "document_family_id": "<string>",
        "headers": {},
        "last_modified": "<string>",
        "lineage_document_uuid": "<string>",
        "mime_type": "<string>",
        "original_filename": "<string>",
        "original_path": "<string>",
        "source_document_uuid": "<string>"
      },
      "sourceContentObjectId": "<string>",
      "storeRef": "<string>",
      "summary": "<string>",
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "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": "DOCUMENT_STORE"
      }
    ]
  },
  "id": "b1234567-89ab-cdef-0123-456789abcdef",
  "locked": true,
  "metadata": {},
  "metadataSource": {},
  "modified": "2023-11-07T05:31:56Z",
  "originalPath": "<string>",
  "path": "invoices/2025/q4/invoice-001.pdf",
  "pendingProcessing": true,
  "size": 245760,
  "statistics": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "id": "b1234567-89ab-cdef-0123-456789abcdef",
    "recentExecutions": [
      {
        "assistant": {
          "active": true,
          "assistantRole": "<string>",
          "changeSequence": 123,
          "chatEnabled": true,
          "color": "<string>",
          "createdOn": "2023-11-07T05:31:56Z",
          "deleteLoggingOnSuccess": true,
          "deleted": true,
          "description": "<string>",
          "id": "b1234567-89ab-cdef-0123-456789abcdef",
          "loggingEnabled": true,
          "name": "<string>",
          "options": {},
          "priorityHint": 123,
          "project": {
            "changeSequence": 123,
            "color": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "dataFlow": {
              "edges": [
                {
                  "id": "b1234567-89ab-cdef-0123-456789abcdef",
                  "properties": {},
                  "source": "<string>",
                  "target": "<string>"
                }
              ],
              "nodes": [
                {
                  "dimensions": {
                    "height": 123,
                    "width": 123
                  },
                  "id": "b1234567-89ab-cdef-0123-456789abcdef",
                  "parentId": "<string>",
                  "position": {
                    "x": 123,
                    "y": 123
                  },
                  "properties": {},
                  "type": "<string>"
                }
              ],
              "viewPort": {
                "x": 123,
                "y": 123,
                "zoom": 123
              }
            },
            "description": "<string>",
            "documentStatuses": [
              {
                "changeSequence": 123,
                "color": "<string>",
                "createdOn": "2023-11-07T05:31:56Z",
                "icon": "<string>",
                "id": "b1234567-89ab-cdef-0123-456789abcdef",
                "slug": "<string>",
                "status": "<string>",
                "statusType": "UNRESOLVED",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>"
              }
            ],
            "id": "b1234567-89ab-cdef-0123-456789abcdef",
            "memory": {
              "changeSequence": 123,
              "orderedDashboards": [
                "<string>"
              ],
              "recentFilters": {},
              "recentQueries": {}
            },
            "name": "<string>",
            "notes": "<string>",
            "options": {
              "dataOptions": [
                {
                  "aliases": [
                    "<string>"
                  ],
                  "default": {},
                  "description": "<string>",
                  "developerOnly": true,
                  "displayProperties": {},
                  "falseLabel": "<string>",
                  "featureFlag": "<string>",
                  "groupOptions": [
                    {}
                  ],
                  "hint": "<string>",
                  "label": "<string>",
                  "listDescription": "<string>",
                  "listLabel": "<string>",
                  "listType": "<string>",
                  "name": "<string>",
                  "overviewMarkdown": "<string>",
                  "possibleValues": [
                    {
                      "description": "<string>",
                      "label": "<string>",
                      "value": {}
                    }
                  ],
                  "properties": {},
                  "required": true,
                  "showIf": "<string>",
                  "showOnPopup": true,
                  "subType": "<string>",
                  "supportArticle": "<string>",
                  "tabName": "<string>",
                  "type": "<string>"
                }
              ],
              "dataProperties": {},
              "groupTaxonTypeFeatures": {},
              "options": [
                {
                  "aliases": [
                    "<string>"
                  ],
                  "default": {},
                  "description": "<string>",
                  "developerOnly": true,
                  "displayProperties": {},
                  "falseLabel": "<string>",
                  "featureFlag": "<string>",
                  "groupOptions": [
                    {}
                  ],
                  "hint": "<string>",
                  "label": "<string>",
                  "listDescription": "<string>",
                  "listLabel": "<string>",
                  "listType": "<string>",
                  "name": "<string>",
                  "overviewMarkdown": "<string>",
                  "possibleValues": [
                    {
                      "description": "<string>",
                      "label": "<string>",
                      "value": {}
                    }
                  ],
                  "properties": {},
                  "required": true,
                  "showIf": "<string>",
                  "showOnPopup": true,
                  "subType": "<string>",
                  "supportArticle": "<string>",
                  "tabName": "<string>",
                  "type": "<string>"
                }
              ],
              "properties": {},
              "taskOptions": {
                "showNewTask": true,
                "showTakeNext": true
              },
              "taxonTypeFeatures": {}
            },
            "organization": {
              "authGroupLink": {
                "authGroup": "<string>"
              },
              "changeSequence": 123,
              "createdOn": "2023-11-07T05:31:56Z",
              "defaultToPrivateTemplates": true,
              "description": "<string>",
              "enterpriseOrganization": true,
              "features": {},
              "hasImage": true,
              "id": "b1234567-89ab-cdef-0123-456789abcdef",
              "memory": {
                "orderedDashboards": [
                  "<string>"
                ]
              },
              "name": "<string>",
              "organizationStatus": "<string>",
              "properties": {},
              "publicAccess": true,
              "searchText": "<string>",
              "slug": "<string>",
              "stripeCustomerId": "<string>",
              "supportAccess": true,
              "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
              "updatedOn": "2023-11-07T05:31:56Z",
              "uuid": "<string>"
            },
            "organizationId": "<string>",
            "owner": {
              "active": true,
              "bio": "<string>",
              "businessGroup": "<string>",
              "changeSequence": 123,
              "createdOn": "2023-11-07T05:31:56Z",
              "email": "<string>",
              "firstName": "<string>",
              "groupsJson": "<string>",
              "id": "b1234567-89ab-cdef-0123-456789abcdef",
              "image": "<string>",
              "isExternallyManaged": true,
              "lastName": "<string>",
              "preferences": {
                "showOnboarding": true,
                "showScrollbars": true,
                "showWelcomeMessage": true
              },
              "roles": {
                "roles": [
                  "<string>"
                ]
              },
              "rolesJson": "<string>",
              "searchText": "<string>",
              "showDeveloperTools": true,
              "title": "<string>",
              "updatedOn": "2023-11-07T05:31:56Z",
              "userStorage": {
                "favoriteLinks": [
                  {
                    "link": "<string>"
                  }
                ]
              },
              "userType": "<string>",
              "uuid": "<string>"
            },
            "ownerId": "<string>",
            "projectTemplateRef": "<string>",
            "searchText": "<string>",
            "slug": "<string>",
            "status": {
              "changeSequence": 123,
              "color": "<string>",
              "createdOn": "2023-11-07T05:31:56Z",
              "icon": "<string>",
              "id": "b1234567-89ab-cdef-0123-456789abcdef",
              "organization": {
                "authGroupLink": {
                  "authGroup": "<string>"
                },
                "changeSequence": 123,
                "createdOn": "2023-11-07T05:31:56Z",
                "defaultToPrivateTemplates": true,
                "description": "<string>",
                "enterpriseOrganization": true,
                "features": {},
                "hasImage": true,
                "id": "b1234567-89ab-cdef-0123-456789abcdef",
                "memory": {
                  "orderedDashboards": [
                    "<string>"
                  ]
                },
                "name": "<string>",
                "organizationStatus": "<string>",
                "properties": {},
                "publicAccess": true,
                "searchText": "<string>",
                "slug": "<string>",
                "stripeCustomerId": "<string>",
                "supportAccess": true,
                "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>"
              },
              "organizationId": "<string>",
              "production": true,
              "status": "<string>",
              "updatedOn": "2023-11-07T05:31:56Z",
              "uuid": "<string>"
            },
            "statusId": "<string>",
            "statusType": "<string>",
            "taskStatuses": [
              {
                "changeSequence": 123,
                "color": "<string>",
                "createdOn": "2023-11-07T05:31:56Z",
                "icon": "<string>",
                "id": "b1234567-89ab-cdef-0123-456789abcdef",
                "label": "<string>",
                "locked": true,
                "slug": "<string>",
                "statusType": "TODO",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>"
              }
            ],
            "templateArticleId": "<string>",
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          },
          "projectId": "<string>",
          "runOnExistingContent": true,
          "showInTraining": true,
          "slug": "<string>",
          "subscription": "<string>",
          "testOptions": {},
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>",
          "validationErrors": {
            "instances": [
              {
                "description": "<string>",
                "message": "<string>",
                "option": "<string>"
              }
            ]
          }
        },
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "execution": {
          "assistantId": "<string>",
          "changeSequence": 123,
          "context": {},
          "createdOn": "2023-11-07T05:31:56Z",
          "deleteLoggingOnSuccess": true,
          "description": "<string>",
          "documentFamilyId": "<string>",
          "endDate": "2023-11-07T05:31:56Z",
          "exceptionDetails": {
            "advice": "<string>",
            "cause": {},
            "description": "<string>",
            "documentationUrl": "<string>",
            "errorMessage": "<string>",
            "errorType": "<string>",
            "executedVersion": "<string>",
            "help": "<string>",
            "message": "<string>",
            "optionErrors": {},
            "stackTrace": [
              {}
            ],
            "statusCode": 123,
            "validationErrors": [
              {
                "description": "<string>",
                "message": "<string>",
                "option": "<string>"
              }
            ]
          },
          "id": "b1234567-89ab-cdef-0123-456789abcdef",
          "idempotencyKey": "<string>",
          "loggingEnabled": true,
          "organizationId": "<string>",
          "parentExecutionId": "<string>",
          "pipeline": {
            "exceptions": [
              {
                "advice": "<string>",
                "cause": {},
                "description": "<string>",
                "documentationUrl": "<string>",
                "errorMessage": "<string>",
                "errorType": "<string>",
                "executedVersion": "<string>",
                "help": "<string>",
                "message": "<string>",
                "optionErrors": {},
                "stackTrace": [
                  {}
                ],
                "statusCode": 123,
                "validationErrors": [
                  {
                    "description": "<string>",
                    "message": "<string>",
                    "option": "<string>"
                  }
                ]
              }
            ],
            "id": "b1234567-89ab-cdef-0123-456789abcdef",
            "ref": "<string>",
            "steps": [
              {
                "conditional": "<string>",
                "context": {},
                "end": "<string>",
                "exceptionDetails": {
                  "advice": "<string>",
                  "cause": {},
                  "description": "<string>",
                  "documentationUrl": "<string>",
                  "errorMessage": "<string>",
                  "errorType": "<string>",
                  "executedVersion": "<string>",
                  "help": "<string>",
                  "message": "<string>",
                  "optionErrors": {},
                  "stackTrace": [
                    {}
                  ],
                  "statusCode": 123,
                  "validationErrors": [
                    {
                      "description": "<string>",
                      "message": "<string>",
                      "option": "<string>"
                    }
                  ]
                },
                "extensionPackRef": "<string>",
                "id": "b1234567-89ab-cdef-0123-456789abcdef",
                "inputId": "<string>",
                "name": "<string>",
                "optionTypes": {},
                "options": {},
                "outputId": "<string>",
                "outputIds": "<string>",
                "processingTime": 123,
                "progress": 123,
                "progressMax": 123,
                "ref": "<string>",
                "start": "<string>",
                "status": "PENDING",
                "statusMessage": "<string>",
                "stepType": "<string>"
              }
            ],
            "valid": true
          },
          "priority": 123,
          "processingTime": 123,
          "sessionId": "<string>",
          "startDate": "2023-11-07T05:31:56Z",
          "status": "PENDING",
          "statusDetails": {
            "detail": "<string>",
            "message": "<string>",
            "progress": 123,
            "progressMax": 123,
            "stepStatus": "<string>"
          },
          "targets": {
            "instances": [
              {
                "contentObjectId": "<string>",
                "documentFamilyId": "<string>",
                "labelsToApply": [
                  "<string>"
                ],
                "ref": "<string>",
                "taxonomyRefs": [
                  "<string>"
                ],
                "type": "<string>"
              }
            ]
          },
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        },
        "id": "b1234567-89ab-cdef-0123-456789abcdef",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
      }
    ],
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "storeRef": "<string>",
  "summary": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}

Authorizations

​
x-api-key
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Unique identifier (UUID) of the resource.

Query Parameters

​
path
string

File path within the store. Defaults to the uploaded filename.

​
metadata
string

JSON string of key-value metadata to attach to the document family.

​
documentVersion
string

Optional document version string.

Body

multipart/form-data
​
file
file
required

File to upload

Response

Created document family

A document family groups related content objects representing a single logical document, tracking its processing lifecycle.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
contentObjects
object[]

Content objects belonging to this document family, ordered by index.

​
created
string<date-time> | null

Original file creation date.

​
createdOn
string<date-time>

Timestamp when the document family was created.

​
deleteUserEmail
string | null

Email of the user who deleted the document family.

​
deleted
boolean

Whether the document family has been soft-deleted.

​
deletedDate
string<date-time> | null

Timestamp when the document family was soft-deleted.

​
documentStatus
string | null

Current processing status of the document.

​
documentTaxonValidations
object[]

Validation results against the document taxonomy.

​
executionTargets
object

Processing execution targets for this document.

​
id
string

Unique identifier (UUID) for the document family.

Example:

"b1234567-89ab-cdef-0123-456789abcdef"

​
locked
boolean

Whether the document family is locked for processing.

​
metadata
object

Document metadata extracted during processing.

​
metadataSource
object

Maps metadata keys to their source content object IDs.

​
modified
string<date-time> | null

Original file modification date.

​
originalPath
string | null

Original path before soft-deletion or rename.

​
path
string

File path or name of the document.

Example:

"invoices/2025/q4/invoice-001.pdf"

​
pendingProcessing
boolean

Whether the document family is queued for processing.

​
size
integer<int64>

File size in bytes.

Example:

245760

​
statistics
object
​
storeRef
string

Reference to the document store containing this document family.

​
summary
string

AI-generated summary of the document content.

​
updatedOn
string<date-time>

Timestamp when the document family was last updated.

​
uuid
string

Secondary UUID identifier.