Get ContentObject by ID

Retrieves a single ContentObject by its unique identifier. Content objects represent individual files or processing results within a document family.

GET /api/content-objects/{id}

Get ContentObject by ID

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/content-objects/{id} \
  --header 'x-api-key: <api-key>'

200

{
  "changeSequence": 123,
  "contentMetadata": {},
  "contentType": 123,
  "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>",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-keybearerAuth

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.

Response

200

application/json

The ContentObject

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

changeSequence · integer<int32> · required

Optimistic locking version number.

contentMetadata · object | null · required

Content-level metadata extracted during processing.

Show child attributes

contentType · integer<int32> · required

Type of content: DOCUMENT or NATIVE.

created · string<date-time> | null · required

createdOn · string<date-time> · required

Timestamp when the content object was created.

docTransitionType · string · required

documentFamilyId · string | null · required

ID of the parent document family.

documentTaxonValidations · object[] | null · required

Show child attributes

documentVersion · string · required

Document version identifier.

id · string · required

Unique identifier (UUID) for the content object.

index · integer<int32> · required

Ordering index within the document family.

metadata · object | null · required

Metadata extracted from the content.

Show child attributes

mixins · string[] | null · required

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

modified · string<date-time> | null · required

name · string · required

size · integer<int64> · required

File size in bytes.

source · object · required

Source/origin metadata for the content object.

Show child attributes

sourceContentObjectId · string | null · required

storeRef · string · required

Reference to the storage location.

summary · string · required

AI-generated summary of the content.

updatedOn · string<date-time> · required

Timestamp when the content object was last updated.

uuid · string · required

Secondary UUID identifier.

deleteUserEmail · string

deleteUserId · string

deleted · boolean | null

deletedDate · string<date-time> | null