Skip to main content
POST
/
api
/
content-objects
Create ContentObject
curl --request POST \
  --url https://platform.kodexa.ai/api/content-objects \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "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": "<string>",
  "index": 123,
  "metadata": {},
  "mixins": [
    "<string>"
  ],
  "modified": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "size": 123,
  "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>"
}
'
{
  "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": "<string>",
  "index": 123,
  "metadata": {},
  "mixins": [
    "<string>"
  ],
  "modified": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "size": 123,
  "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>"
}

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 content object represents an individual file or processing result within a document family.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
contentMetadata
object

Content-level metadata extracted during processing.

​
contentType
string

Type of content: DOCUMENT or NATIVE.

​
created
string<date-time> | null
​
createdOn
string<date-time>

Timestamp when the content object was created.

​
docTransitionType
string
​
documentFamilyId
string | null

ID of the parent document family.

​
documentTaxonValidations
object[]
​
documentVersion
string

Document version identifier.

​
id
string

Unique identifier (UUID) for the content object.

​
index
integer<int32>

Ordering index within the document family.

​
metadata
object

Metadata extracted from the content.

​
mixins
string[]

List of mixin names applied to this content object (e.g., spatial, workbook, text).

​
modified
string<date-time> | null
​
name
string
​
size
integer<int64>

File size in bytes.

​
source
object

Source/origin metadata for the content object.

​
sourceContentObjectId
string | null
​
storeRef
string

Reference to the storage location.

​
summary
string

AI-generated summary of the content.

​
updatedOn
string<date-time>

Timestamp when the content object was last updated.

​
uuid
string

Secondary UUID identifier.

Response

Created ContentObject

A content object represents an individual file or processing result within a document family.

​
changeSequence
integer<int32>

Optimistic locking version number.

​
contentMetadata
object

Content-level metadata extracted during processing.

​
contentType
string

Type of content: DOCUMENT or NATIVE.

​
created
string<date-time> | null
​
createdOn
string<date-time>

Timestamp when the content object was created.

​
docTransitionType
string
​
documentFamilyId
string | null

ID of the parent document family.

​
documentTaxonValidations
object[]
​
documentVersion
string

Document version identifier.

​
id
string

Unique identifier (UUID) for the content object.

​
index
integer<int32>

Ordering index within the document family.

​
metadata
object

Metadata extracted from the content.

​
mixins
string[]

List of mixin names applied to this content object (e.g., spatial, workbook, text).

​
modified
string<date-time> | null
​
name
string
​
size
integer<int64>

File size in bytes.

​
source
object

Source/origin metadata for the content object.

​
sourceContentObjectId
string | null
​
storeRef
string

Reference to the storage location.

​
summary
string

AI-generated summary of the content.

​
updatedOn
string<date-time>

Timestamp when the content object was last updated.

​
uuid
string

Secondary UUID identifier.