Skip to main content
GET
/
api
/
content-objects
/
{id}
Get ContentObject by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/content-objects/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "contentMetadata": {},
  "contentType": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdOn": "2023-11-07T05:31:56Z",
  "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": {},
  "modified": "2023-11-07T05:31:56Z",
  "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>"
  },
  "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.

Response

The ContentObject

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

changeSequence
integer<int32>

Optimistic locking version number.

contentMetadata
object
contentType
string
created
string<date-time> | null
createdOn
string<date-time>

Timestamp when the content object was created.

documentFamilyId
string | null
documentTaxonValidations
object[]
documentVersion
string
id
string

Unique identifier (UUID) for the content object.

index
integer<int32>
metadata
object
mixins
object
modified
string<date-time> | null
size
integer<int64>
source
object
storeRef
string
summary
string
updatedOn
string<date-time>

Timestamp when the content object was last updated.

uuid
string

Secondary UUID identifier.