Update DocumentFamily
curl --request PUT \
--url https://platform.kodexa.ai/api/document-families/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"contentObjects": [
{
"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>"
}
],
"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>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
]
}
]
},
"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": "<string>",
"recentExecutions": [
{
"assistant": {
"active": true,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": true,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": [
"<string>"
],
"pipeline": {
"steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
]
},
"prompt": "<string>",
"taxonomies": [
"<string>"
]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<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": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": true,
"showInTraining": true,
"slug": "invoice-extractor",
"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",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"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": "<string>",
"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>"
}
'import requests
url = "https://platform.kodexa.ai/api/document-families/{id}"
payload = {
"changeSequence": 123,
"contentObjects": [
{
"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>"
}
],
"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>" },
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": ["<string>"],
"ref": "<string>",
"taxonomyRefs": ["<string>"]
}
] },
"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": "<string>",
"recentExecutions": [
{
"assistant": {
"active": True,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": True,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": True,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": ["<string>"],
"pipeline": { "steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
] },
"prompt": "<string>",
"taxonomies": ["<string>"]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": ["<string>"],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": { "showNewTask": True },
"taxonTypeFeatures": {}
},
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<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": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": True,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": True,
"showInTraining": True,
"slug": "invoice-extractor",
"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",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": ["<unknown>"],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": ["<unknown>"],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": ["<unknown>"],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": True
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"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": "<string>",
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
contentObjects: [
{
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>'
}
],
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>'},
contentObjectId: '<string>',
documentFamilyId: '<string>',
labelsToApply: ['<string>'],
ref: '<string>',
taxonomyRefs: ['<string>']
}
]
},
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: '<string>',
recentExecutions: [
{
assistant: {
active: true,
assistantRole: '<string>',
changeSequence: 123,
chatEnabled: true,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
deleted: true,
description: '<string>',
id: 'e4567890-12ab-cdef-3456-789012abcdef',
name: 'Invoice Extractor',
options: {
agentRuntimeId: '<string>',
complete_label: '<string>',
moduleRefs: ['<string>'],
pipeline: {
steps: [
{
conditional: '<string>',
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
name: '<string>',
options: {},
ref: '<string>',
stepType: '<string>'
}
]
},
prompt: '<string>',
taxonomies: ['<string>']
},
priorityHint: 123,
project: {
changeSequence: 123,
color: '#4A90D9',
createdOn: '2023-11-07T05:31:56Z',
dataFlow: {
edges: [{id: '<string>', properties: {}, source: '<string>', target: '<string>'}],
nodes: [
{
dimensions: {height: 123, width: 123},
id: '<string>',
parentId: '<string>',
position: {x: 123, y: 123},
properties: {},
type: '<string>'
}
],
viewPort: {x: 123, y: 123, zoom: 123}
},
description: 'Automated invoice processing pipeline.',
documentStatuses: [
{
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
project: '<unknown>',
projectId: '<string>',
slug: '<string>',
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
id: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
memory: {
changeSequence: 123,
orderedDashboards: ['<string>'],
recentFilters: {},
recentQueries: {}
},
name: 'Invoice Processing',
notes: '<string>',
options: {
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
dataOptions: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
dataProperties: {},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
groupTaxonTypeFeatures: {},
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
properties: {},
taskOptions: {showNewTask: true},
taxonTypeFeatures: {}
},
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
owner: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<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: 'invoice-processing',
status: {
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
production: true,
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
statusId: '<string>',
statusType: 'ACTIVE',
templateArticleId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '7c9e667974254de944be07fc1f90ae7'
},
projectId: '<string>',
runOnExistingContent: true,
showInTraining: true,
slug: 'invoice-extractor',
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',
description: '<string>',
documentFamilyId: '<string>',
endDate: '2023-11-07T05:31:56Z',
exceptionDetails: {
advice: '<string>',
cause: '<unknown>',
description: '<string>',
documentationUrl: '<string>',
errorMessage: '<string>',
errorType: '<string>',
executedVersion: '<string>',
help: '<string>',
message: '<string>',
optionErrors: {},
stackTrace: ['<unknown>'],
statusCode: 123,
validationErrors: [{description: '<string>', message: '<string>', option: '<string>'}]
},
id: '<string>',
idempotencyKey: '<string>',
organizationId: '<string>',
parentExecutionId: '<string>',
pipeline: {
exceptions: [
{
advice: '<string>',
cause: '<unknown>',
description: '<string>',
documentationUrl: '<string>',
errorMessage: '<string>',
errorType: '<string>',
executedVersion: '<string>',
help: '<string>',
message: '<string>',
optionErrors: {},
stackTrace: ['<unknown>'],
statusCode: 123,
validationErrors: [{description: '<string>', message: '<string>', option: '<string>'}]
}
],
id: '<string>',
ref: '<string>',
steps: [
{
conditional: '<string>',
context: {},
end: '<string>',
exceptionDetails: {
advice: '<string>',
cause: '<unknown>',
description: '<string>',
documentationUrl: '<string>',
errorMessage: '<string>',
errorType: '<string>',
executedVersion: '<string>',
help: '<string>',
message: '<string>',
optionErrors: {},
stackTrace: ['<unknown>'],
statusCode: 123,
validationErrors: [{description: '<string>', message: '<string>', option: '<string>'}]
},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
extensionPackRef: '<string>',
id: '<string>',
inputId: '<string>',
name: '<string>',
optionTypes: {},
options: {},
outputId: '<string>',
outputIds: '<string>',
processingTime: 123,
progress: 123,
progressMax: 123,
ref: '<string>',
start: '<string>',
statusMessage: '<string>',
stepType: 'MODULE'
}
],
valid: true
},
priority: 123,
processingTime: 123,
sessionId: '<string>',
startDate: '2023-11-07T05:31:56Z',
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: '<string>',
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>'
})
};
fetch('https://platform.kodexa.ai/api/document-families/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/document-families/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'contentObjects' => [
[
'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>'
]
],
'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>'
],
'contentObjectId' => '<string>',
'documentFamilyId' => '<string>',
'labelsToApply' => [
'<string>'
],
'ref' => '<string>',
'taxonomyRefs' => [
'<string>'
]
]
]
],
'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' => '<string>',
'recentExecutions' => [
[
'assistant' => [
'active' => true,
'assistantRole' => '<string>',
'changeSequence' => 123,
'chatEnabled' => true,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'deleted' => true,
'description' => '<string>',
'id' => 'e4567890-12ab-cdef-3456-789012abcdef',
'name' => 'Invoice Extractor',
'options' => [
'agentRuntimeId' => '<string>',
'complete_label' => '<string>',
'moduleRefs' => [
'<string>'
],
'pipeline' => [
'steps' => [
[
'conditional' => '<string>',
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'name' => '<string>',
'options' => [
],
'ref' => '<string>',
'stepType' => '<string>'
]
]
],
'prompt' => '<string>',
'taxonomies' => [
'<string>'
]
],
'priorityHint' => 123,
'project' => [
'changeSequence' => 123,
'color' => '#4A90D9',
'createdOn' => '2023-11-07T05:31:56Z',
'dataFlow' => [
'edges' => [
[
'id' => '<string>',
'properties' => [
],
'source' => '<string>',
'target' => '<string>'
]
],
'nodes' => [
[
'dimensions' => [
'height' => 123,
'width' => 123
],
'id' => '<string>',
'parentId' => '<string>',
'position' => [
'x' => 123,
'y' => 123
],
'properties' => [
],
'type' => '<string>'
]
],
'viewPort' => [
'x' => 123,
'y' => 123,
'zoom' => 123
]
],
'description' => 'Automated invoice processing pipeline.',
'documentStatuses' => [
[
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'project' => '<unknown>',
'projectId' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'memory' => [
'changeSequence' => 123,
'orderedDashboards' => [
'<string>'
],
'recentFilters' => [
],
'recentQueries' => [
]
],
'name' => 'Invoice Processing',
'notes' => '<string>',
'options' => [
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'dataOptions' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'dataProperties' => [
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'groupTaxonTypeFeatures' => [
],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'properties' => [
],
'taskOptions' => [
'showNewTask' => true
],
'taxonTypeFeatures' => [
]
],
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'owner' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<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' => 'invoice-processing',
'status' => [
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'production' => true,
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'statusId' => '<string>',
'statusType' => 'ACTIVE',
'templateArticleId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '7c9e667974254de944be07fc1f90ae7'
],
'projectId' => '<string>',
'runOnExistingContent' => true,
'showInTraining' => true,
'slug' => 'invoice-extractor',
'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',
'description' => '<string>',
'documentFamilyId' => '<string>',
'endDate' => '2023-11-07T05:31:56Z',
'exceptionDetails' => [
'advice' => '<string>',
'cause' => '<unknown>',
'description' => '<string>',
'documentationUrl' => '<string>',
'errorMessage' => '<string>',
'errorType' => '<string>',
'executedVersion' => '<string>',
'help' => '<string>',
'message' => '<string>',
'optionErrors' => [
],
'stackTrace' => [
'<unknown>'
],
'statusCode' => 123,
'validationErrors' => [
[
'description' => '<string>',
'message' => '<string>',
'option' => '<string>'
]
]
],
'id' => '<string>',
'idempotencyKey' => '<string>',
'organizationId' => '<string>',
'parentExecutionId' => '<string>',
'pipeline' => [
'exceptions' => [
[
'advice' => '<string>',
'cause' => '<unknown>',
'description' => '<string>',
'documentationUrl' => '<string>',
'errorMessage' => '<string>',
'errorType' => '<string>',
'executedVersion' => '<string>',
'help' => '<string>',
'message' => '<string>',
'optionErrors' => [
],
'stackTrace' => [
'<unknown>'
],
'statusCode' => 123,
'validationErrors' => [
[
'description' => '<string>',
'message' => '<string>',
'option' => '<string>'
]
]
]
],
'id' => '<string>',
'ref' => '<string>',
'steps' => [
[
'conditional' => '<string>',
'context' => [
],
'end' => '<string>',
'exceptionDetails' => [
'advice' => '<string>',
'cause' => '<unknown>',
'description' => '<string>',
'documentationUrl' => '<string>',
'errorMessage' => '<string>',
'errorType' => '<string>',
'executedVersion' => '<string>',
'help' => '<string>',
'message' => '<string>',
'optionErrors' => [
],
'stackTrace' => [
'<unknown>'
],
'statusCode' => 123,
'validationErrors' => [
[
'description' => '<string>',
'message' => '<string>',
'option' => '<string>'
]
]
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'extensionPackRef' => '<string>',
'id' => '<string>',
'inputId' => '<string>',
'name' => '<string>',
'optionTypes' => [
],
'options' => [
],
'outputId' => '<string>',
'outputIds' => '<string>',
'processingTime' => 123,
'progress' => 123,
'progressMax' => 123,
'ref' => '<string>',
'start' => '<string>',
'statusMessage' => '<string>',
'stepType' => 'MODULE'
]
],
'valid' => true
],
'priority' => 123,
'processingTime' => 123,
'sessionId' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'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' => '<string>',
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/document-families/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"contentObjects\": [\n {\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"documentStatus\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"executionTargets\": {\n \"instances\": [\n {\n \"actor\": {\n \"actorId\": \"<string>\"\n },\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"b1234567-89ab-cdef-0123-456789abcdef\",\n \"locked\": true,\n \"metadata\": {},\n \"metadataSource\": {},\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"originalPath\": \"<string>\",\n \"path\": \"invoices/2025/q4/invoice-001.pdf\",\n \"pendingProcessing\": true,\n \"size\": 245760,\n \"statistics\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"recentExecutions\": [\n {\n \"assistant\": {\n \"active\": true,\n \"assistantRole\": \"<string>\",\n \"changeSequence\": 123,\n \"chatEnabled\": true,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"e4567890-12ab-cdef-3456-789012abcdef\",\n \"name\": \"Invoice Extractor\",\n \"options\": {\n \"agentRuntimeId\": \"<string>\",\n \"complete_label\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"pipeline\": {\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"name\": \"<string>\",\n \"options\": {},\n \"ref\": \"<string>\",\n \"stepType\": \"<string>\"\n }\n ]\n },\n \"prompt\": \"<string>\",\n \"taxonomies\": [\n \"<string>\"\n ]\n },\n \"priorityHint\": 123,\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"runOnExistingContent\": true,\n \"showInTraining\": true,\n \"slug\": \"invoice-extractor\",\n \"subscription\": \"<string>\",\n \"testOptions\": {},\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"validationErrors\": {\n \"instances\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"execution\": {\n \"assistantId\": \"<string>\",\n \"changeSequence\": 123,\n \"context\": {},\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"parentExecutionId\": \"<string>\",\n \"pipeline\": {\n \"exceptions\": [\n {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n ],\n \"id\": \"<string>\",\n \"ref\": \"<string>\",\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"context\": {},\n \"end\": \"<string>\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"inputId\": \"<string>\",\n \"name\": \"<string>\",\n \"optionTypes\": {},\n \"options\": {},\n \"outputId\": \"<string>\",\n \"outputIds\": \"<string>\",\n \"processingTime\": 123,\n \"progress\": 123,\n \"progressMax\": 123,\n \"ref\": \"<string>\",\n \"start\": \"<string>\",\n \"statusMessage\": \"<string>\",\n \"stepType\": \"MODULE\"\n }\n ],\n \"valid\": true\n },\n \"priority\": 123,\n \"processingTime\": 123,\n \"sessionId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"statusDetails\": {\n \"detail\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": 123,\n \"progressMax\": 123,\n \"stepStatus\": \"<string>\"\n },\n \"targets\": {\n \"instances\": [\n {\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://platform.kodexa.ai/api/document-families/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"contentObjects\": [\n {\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"documentStatus\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"executionTargets\": {\n \"instances\": [\n {\n \"actor\": {\n \"actorId\": \"<string>\"\n },\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"b1234567-89ab-cdef-0123-456789abcdef\",\n \"locked\": true,\n \"metadata\": {},\n \"metadataSource\": {},\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"originalPath\": \"<string>\",\n \"path\": \"invoices/2025/q4/invoice-001.pdf\",\n \"pendingProcessing\": true,\n \"size\": 245760,\n \"statistics\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"recentExecutions\": [\n {\n \"assistant\": {\n \"active\": true,\n \"assistantRole\": \"<string>\",\n \"changeSequence\": 123,\n \"chatEnabled\": true,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"e4567890-12ab-cdef-3456-789012abcdef\",\n \"name\": \"Invoice Extractor\",\n \"options\": {\n \"agentRuntimeId\": \"<string>\",\n \"complete_label\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"pipeline\": {\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"name\": \"<string>\",\n \"options\": {},\n \"ref\": \"<string>\",\n \"stepType\": \"<string>\"\n }\n ]\n },\n \"prompt\": \"<string>\",\n \"taxonomies\": [\n \"<string>\"\n ]\n },\n \"priorityHint\": 123,\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"runOnExistingContent\": true,\n \"showInTraining\": true,\n \"slug\": \"invoice-extractor\",\n \"subscription\": \"<string>\",\n \"testOptions\": {},\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"validationErrors\": {\n \"instances\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"execution\": {\n \"assistantId\": \"<string>\",\n \"changeSequence\": 123,\n \"context\": {},\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"parentExecutionId\": \"<string>\",\n \"pipeline\": {\n \"exceptions\": [\n {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n ],\n \"id\": \"<string>\",\n \"ref\": \"<string>\",\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"context\": {},\n \"end\": \"<string>\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"inputId\": \"<string>\",\n \"name\": \"<string>\",\n \"optionTypes\": {},\n \"options\": {},\n \"outputId\": \"<string>\",\n \"outputIds\": \"<string>\",\n \"processingTime\": 123,\n \"progress\": 123,\n \"progressMax\": 123,\n \"ref\": \"<string>\",\n \"start\": \"<string>\",\n \"statusMessage\": \"<string>\",\n \"stepType\": \"MODULE\"\n }\n ],\n \"valid\": true\n },\n \"priority\": 123,\n \"processingTime\": 123,\n \"sessionId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"statusDetails\": {\n \"detail\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": 123,\n \"progressMax\": 123,\n \"stepStatus\": \"<string>\"\n },\n \"targets\": {\n \"instances\": [\n {\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/document-families/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"contentObjects\": [\n {\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"documentStatus\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"executionTargets\": {\n \"instances\": [\n {\n \"actor\": {\n \"actorId\": \"<string>\"\n },\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"b1234567-89ab-cdef-0123-456789abcdef\",\n \"locked\": true,\n \"metadata\": {},\n \"metadataSource\": {},\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"originalPath\": \"<string>\",\n \"path\": \"invoices/2025/q4/invoice-001.pdf\",\n \"pendingProcessing\": true,\n \"size\": 245760,\n \"statistics\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"recentExecutions\": [\n {\n \"assistant\": {\n \"active\": true,\n \"assistantRole\": \"<string>\",\n \"changeSequence\": 123,\n \"chatEnabled\": true,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"e4567890-12ab-cdef-3456-789012abcdef\",\n \"name\": \"Invoice Extractor\",\n \"options\": {\n \"agentRuntimeId\": \"<string>\",\n \"complete_label\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"pipeline\": {\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"name\": \"<string>\",\n \"options\": {},\n \"ref\": \"<string>\",\n \"stepType\": \"<string>\"\n }\n ]\n },\n \"prompt\": \"<string>\",\n \"taxonomies\": [\n \"<string>\"\n ]\n },\n \"priorityHint\": 123,\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"runOnExistingContent\": true,\n \"showInTraining\": true,\n \"slug\": \"invoice-extractor\",\n \"subscription\": \"<string>\",\n \"testOptions\": {},\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"validationErrors\": {\n \"instances\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"execution\": {\n \"assistantId\": \"<string>\",\n \"changeSequence\": 123,\n \"context\": {},\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"parentExecutionId\": \"<string>\",\n \"pipeline\": {\n \"exceptions\": [\n {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n ],\n \"id\": \"<string>\",\n \"ref\": \"<string>\",\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"context\": {},\n \"end\": \"<string>\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"inputId\": \"<string>\",\n \"name\": \"<string>\",\n \"optionTypes\": {},\n \"options\": {},\n \"outputId\": \"<string>\",\n \"outputIds\": \"<string>\",\n \"processingTime\": 123,\n \"progress\": 123,\n \"progressMax\": 123,\n \"ref\": \"<string>\",\n \"start\": \"<string>\",\n \"statusMessage\": \"<string>\",\n \"stepType\": \"MODULE\"\n }\n ],\n \"valid\": true\n },\n \"priority\": 123,\n \"processingTime\": 123,\n \"sessionId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"statusDetails\": {\n \"detail\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": 123,\n \"progressMax\": 123,\n \"stepStatus\": \"<string>\"\n },\n \"targets\": {\n \"instances\": [\n {\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"contentObjects": [
{
"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>"
}
],
"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>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
]
}
]
},
"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": "<string>",
"recentExecutions": [
{
"assistant": {
"active": true,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": true,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": [
"<string>"
],
"pipeline": {
"steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
]
},
"prompt": "<string>",
"taxonomies": [
"<string>"
]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<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": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": true,
"showInTraining": true,
"slug": "invoice-extractor",
"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",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"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": "<string>",
"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>"
}DocumentFamilies
Update DocumentFamily
Updates an existing DocumentFamily. Document families group related content objects representing a single logical document.
PUT
/
api
/
document-families
/
{id}
Update DocumentFamily
curl --request PUT \
--url https://platform.kodexa.ai/api/document-families/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"changeSequence": 123,
"contentObjects": [
{
"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>"
}
],
"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>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
]
}
]
},
"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": "<string>",
"recentExecutions": [
{
"assistant": {
"active": true,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": true,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": [
"<string>"
],
"pipeline": {
"steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
]
},
"prompt": "<string>",
"taxonomies": [
"<string>"
]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<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": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": true,
"showInTraining": true,
"slug": "invoice-extractor",
"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",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"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": "<string>",
"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>"
}
'import requests
url = "https://platform.kodexa.ai/api/document-families/{id}"
payload = {
"changeSequence": 123,
"contentObjects": [
{
"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>"
}
],
"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>" },
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": ["<string>"],
"ref": "<string>",
"taxonomyRefs": ["<string>"]
}
] },
"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": "<string>",
"recentExecutions": [
{
"assistant": {
"active": True,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": True,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": True,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": ["<string>"],
"pipeline": { "steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
] },
"prompt": "<string>",
"taxonomies": ["<string>"]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": ["<string>"],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": ["<string>"],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": ["<string>"],
"default": "<unknown>",
"description": "<string>",
"developerOnly": True,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": True,
"showIf": "<string>",
"showOnPopup": True,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": { "showNewTask": True },
"taxonTypeFeatures": {}
},
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": True,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": True,
"lastName": "<string>",
"preferences": {
"showOnboarding": True,
"showScrollbars": True,
"showWelcomeMessage": True
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": { "roles": ["<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": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": True,
"authGroupLink": { "authGroup": "<string>" },
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": True,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": True,
"features": {},
"hasImage": True,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": { "orderedDashboards": ["<string>"] },
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": True,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": True,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": True,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": True,
"showInTraining": True,
"slug": "invoice-extractor",
"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",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": ["<unknown>"],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": ["<unknown>"],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": ["<unknown>"],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": True
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"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": "<string>",
"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>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
changeSequence: 123,
contentObjects: [
{
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>'
}
],
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>'},
contentObjectId: '<string>',
documentFamilyId: '<string>',
labelsToApply: ['<string>'],
ref: '<string>',
taxonomyRefs: ['<string>']
}
]
},
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: '<string>',
recentExecutions: [
{
assistant: {
active: true,
assistantRole: '<string>',
changeSequence: 123,
chatEnabled: true,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
deleted: true,
description: '<string>',
id: 'e4567890-12ab-cdef-3456-789012abcdef',
name: 'Invoice Extractor',
options: {
agentRuntimeId: '<string>',
complete_label: '<string>',
moduleRefs: ['<string>'],
pipeline: {
steps: [
{
conditional: '<string>',
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
name: '<string>',
options: {},
ref: '<string>',
stepType: '<string>'
}
]
},
prompt: '<string>',
taxonomies: ['<string>']
},
priorityHint: 123,
project: {
changeSequence: 123,
color: '#4A90D9',
createdOn: '2023-11-07T05:31:56Z',
dataFlow: {
edges: [{id: '<string>', properties: {}, source: '<string>', target: '<string>'}],
nodes: [
{
dimensions: {height: 123, width: 123},
id: '<string>',
parentId: '<string>',
position: {x: 123, y: 123},
properties: {},
type: '<string>'
}
],
viewPort: {x: 123, y: 123, zoom: 123}
},
description: 'Automated invoice processing pipeline.',
documentStatuses: [
{
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
project: '<unknown>',
projectId: '<string>',
slug: '<string>',
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
}
],
id: '7c9e6679-7425-40de-944b-e07fc1f90ae7',
memory: {
changeSequence: 123,
orderedDashboards: ['<string>'],
recentFilters: {},
recentQueries: {}
},
name: 'Invoice Processing',
notes: '<string>',
options: {
companion: {agentRuntimeRef: '<string>', moduleRefs: ['<string>'], prompt: '<string>'},
dataOptions: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
dataProperties: {},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
groupTaxonTypeFeatures: {},
options: [
{
aliases: ['<string>'],
default: '<unknown>',
description: '<string>',
developerOnly: true,
displayProperties: {},
falseLabel: '<string>',
featureFlag: '<string>',
groupOptions: '<array>',
hint: '<string>',
label: '<string>',
listDescription: '<string>',
listLabel: '<string>',
listType: '<string>',
name: '<string>',
overviewMarkdown: '<string>',
possibleValues: [{description: '<string>', label: '<string>', value: '<unknown>'}],
properties: {},
required: true,
showIf: '<string>',
showOnPopup: true,
subType: '<string>',
supportArticle: '<string>',
tabName: '<string>',
type: '<string>'
}
],
properties: {},
taskOptions: {showNewTask: true},
taxonTypeFeatures: {}
},
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
owner: {
active: true,
bio: '<string>',
businessGroup: '<string>',
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
email: '<string>',
firstName: '<string>',
groupsJson: '<string>',
id: '<string>',
image: '<string>',
isExternallyManaged: true,
lastName: '<string>',
preferences: {showOnboarding: true, showScrollbars: true, showWelcomeMessage: true},
rolesJson: '<string>',
searchText: '<string>',
security: {roles: ['<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: 'invoice-processing',
status: {
changeSequence: 123,
color: '<string>',
createdOn: '2023-11-07T05:31:56Z',
icon: '<string>',
id: '<string>',
organization: {
archived: true,
authGroupLink: {authGroup: '<string>'},
changeSequence: 123,
createdOn: '2023-11-07T05:31:56Z',
defaultToPrivateTemplates: true,
description: 'Document processing organization for Acme Corp.',
enterpriseOrganization: true,
features: {},
hasImage: true,
id: '550e8400-e29b-41d4-a716-446655440000',
memory: {orderedDashboards: ['<string>']},
name: 'Acme Corp',
organizationStatus: 'ACTIVE',
properties: {},
publicAccess: true,
searchText: '<string>',
slug: 'acme-corp',
stripeCustomerId: '<string>',
supportAccess: true,
supportAccessExpiresAt: '2023-11-07T05:31:56Z',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '550e8400e29b41d4a716446655440000'
},
organizationId: '<string>',
production: true,
status: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '<string>'
},
statusId: '<string>',
statusType: 'ACTIVE',
templateArticleId: '<string>',
updatedOn: '2023-11-07T05:31:56Z',
uuid: '7c9e667974254de944be07fc1f90ae7'
},
projectId: '<string>',
runOnExistingContent: true,
showInTraining: true,
slug: 'invoice-extractor',
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',
description: '<string>',
documentFamilyId: '<string>',
endDate: '2023-11-07T05:31:56Z',
exceptionDetails: {
advice: '<string>',
cause: '<unknown>',
description: '<string>',
documentationUrl: '<string>',
errorMessage: '<string>',
errorType: '<string>',
executedVersion: '<string>',
help: '<string>',
message: '<string>',
optionErrors: {},
stackTrace: ['<unknown>'],
statusCode: 123,
validationErrors: [{description: '<string>', message: '<string>', option: '<string>'}]
},
id: '<string>',
idempotencyKey: '<string>',
organizationId: '<string>',
parentExecutionId: '<string>',
pipeline: {
exceptions: [
{
advice: '<string>',
cause: '<unknown>',
description: '<string>',
documentationUrl: '<string>',
errorMessage: '<string>',
errorType: '<string>',
executedVersion: '<string>',
help: '<string>',
message: '<string>',
optionErrors: {},
stackTrace: ['<unknown>'],
statusCode: 123,
validationErrors: [{description: '<string>', message: '<string>', option: '<string>'}]
}
],
id: '<string>',
ref: '<string>',
steps: [
{
conditional: '<string>',
context: {},
end: '<string>',
exceptionDetails: {
advice: '<string>',
cause: '<unknown>',
description: '<string>',
documentationUrl: '<string>',
errorMessage: '<string>',
errorType: '<string>',
executedVersion: '<string>',
help: '<string>',
message: '<string>',
optionErrors: {},
stackTrace: ['<unknown>'],
statusCode: 123,
validationErrors: [{description: '<string>', message: '<string>', option: '<string>'}]
},
executionPolicy: {
backoffBaseSeconds: 123,
backoffStrategy: '<string>',
maxAttempts: 123,
onExhausted: '<string>',
timeoutSeconds: 123
},
extensionPackRef: '<string>',
id: '<string>',
inputId: '<string>',
name: '<string>',
optionTypes: {},
options: {},
outputId: '<string>',
outputIds: '<string>',
processingTime: 123,
progress: 123,
progressMax: 123,
ref: '<string>',
start: '<string>',
statusMessage: '<string>',
stepType: 'MODULE'
}
],
valid: true
},
priority: 123,
processingTime: 123,
sessionId: '<string>',
startDate: '2023-11-07T05:31:56Z',
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: '<string>',
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>'
})
};
fetch('https://platform.kodexa.ai/api/document-families/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://platform.kodexa.ai/api/document-families/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'changeSequence' => 123,
'contentObjects' => [
[
'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>'
]
],
'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>'
],
'contentObjectId' => '<string>',
'documentFamilyId' => '<string>',
'labelsToApply' => [
'<string>'
],
'ref' => '<string>',
'taxonomyRefs' => [
'<string>'
]
]
]
],
'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' => '<string>',
'recentExecutions' => [
[
'assistant' => [
'active' => true,
'assistantRole' => '<string>',
'changeSequence' => 123,
'chatEnabled' => true,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'deleted' => true,
'description' => '<string>',
'id' => 'e4567890-12ab-cdef-3456-789012abcdef',
'name' => 'Invoice Extractor',
'options' => [
'agentRuntimeId' => '<string>',
'complete_label' => '<string>',
'moduleRefs' => [
'<string>'
],
'pipeline' => [
'steps' => [
[
'conditional' => '<string>',
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'name' => '<string>',
'options' => [
],
'ref' => '<string>',
'stepType' => '<string>'
]
]
],
'prompt' => '<string>',
'taxonomies' => [
'<string>'
]
],
'priorityHint' => 123,
'project' => [
'changeSequence' => 123,
'color' => '#4A90D9',
'createdOn' => '2023-11-07T05:31:56Z',
'dataFlow' => [
'edges' => [
[
'id' => '<string>',
'properties' => [
],
'source' => '<string>',
'target' => '<string>'
]
],
'nodes' => [
[
'dimensions' => [
'height' => 123,
'width' => 123
],
'id' => '<string>',
'parentId' => '<string>',
'position' => [
'x' => 123,
'y' => 123
],
'properties' => [
],
'type' => '<string>'
]
],
'viewPort' => [
'x' => 123,
'y' => 123,
'zoom' => 123
]
],
'description' => 'Automated invoice processing pipeline.',
'documentStatuses' => [
[
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'project' => '<unknown>',
'projectId' => '<string>',
'slug' => '<string>',
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
]
],
'id' => '7c9e6679-7425-40de-944b-e07fc1f90ae7',
'memory' => [
'changeSequence' => 123,
'orderedDashboards' => [
'<string>'
],
'recentFilters' => [
],
'recentQueries' => [
]
],
'name' => 'Invoice Processing',
'notes' => '<string>',
'options' => [
'companion' => [
'agentRuntimeRef' => '<string>',
'moduleRefs' => [
'<string>'
],
'prompt' => '<string>'
],
'dataOptions' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'dataProperties' => [
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'groupTaxonTypeFeatures' => [
],
'options' => [
[
'aliases' => [
'<string>'
],
'default' => '<unknown>',
'description' => '<string>',
'developerOnly' => true,
'displayProperties' => [
],
'falseLabel' => '<string>',
'featureFlag' => '<string>',
'groupOptions' => '<array>',
'hint' => '<string>',
'label' => '<string>',
'listDescription' => '<string>',
'listLabel' => '<string>',
'listType' => '<string>',
'name' => '<string>',
'overviewMarkdown' => '<string>',
'possibleValues' => [
[
'description' => '<string>',
'label' => '<string>',
'value' => '<unknown>'
]
],
'properties' => [
],
'required' => true,
'showIf' => '<string>',
'showOnPopup' => true,
'subType' => '<string>',
'supportArticle' => '<string>',
'tabName' => '<string>',
'type' => '<string>'
]
],
'properties' => [
],
'taskOptions' => [
'showNewTask' => true
],
'taxonTypeFeatures' => [
]
],
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'owner' => [
'active' => true,
'bio' => '<string>',
'businessGroup' => '<string>',
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'email' => '<string>',
'firstName' => '<string>',
'groupsJson' => '<string>',
'id' => '<string>',
'image' => '<string>',
'isExternallyManaged' => true,
'lastName' => '<string>',
'preferences' => [
'showOnboarding' => true,
'showScrollbars' => true,
'showWelcomeMessage' => true
],
'rolesJson' => '<string>',
'searchText' => '<string>',
'security' => [
'roles' => [
'<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' => 'invoice-processing',
'status' => [
'changeSequence' => 123,
'color' => '<string>',
'createdOn' => '2023-11-07T05:31:56Z',
'icon' => '<string>',
'id' => '<string>',
'organization' => [
'archived' => true,
'authGroupLink' => [
'authGroup' => '<string>'
],
'changeSequence' => 123,
'createdOn' => '2023-11-07T05:31:56Z',
'defaultToPrivateTemplates' => true,
'description' => 'Document processing organization for Acme Corp.',
'enterpriseOrganization' => true,
'features' => [
],
'hasImage' => true,
'id' => '550e8400-e29b-41d4-a716-446655440000',
'memory' => [
'orderedDashboards' => [
'<string>'
]
],
'name' => 'Acme Corp',
'organizationStatus' => 'ACTIVE',
'properties' => [
],
'publicAccess' => true,
'searchText' => '<string>',
'slug' => 'acme-corp',
'stripeCustomerId' => '<string>',
'supportAccess' => true,
'supportAccessExpiresAt' => '2023-11-07T05:31:56Z',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '550e8400e29b41d4a716446655440000'
],
'organizationId' => '<string>',
'production' => true,
'status' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '<string>'
],
'statusId' => '<string>',
'statusType' => 'ACTIVE',
'templateArticleId' => '<string>',
'updatedOn' => '2023-11-07T05:31:56Z',
'uuid' => '7c9e667974254de944be07fc1f90ae7'
],
'projectId' => '<string>',
'runOnExistingContent' => true,
'showInTraining' => true,
'slug' => 'invoice-extractor',
'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',
'description' => '<string>',
'documentFamilyId' => '<string>',
'endDate' => '2023-11-07T05:31:56Z',
'exceptionDetails' => [
'advice' => '<string>',
'cause' => '<unknown>',
'description' => '<string>',
'documentationUrl' => '<string>',
'errorMessage' => '<string>',
'errorType' => '<string>',
'executedVersion' => '<string>',
'help' => '<string>',
'message' => '<string>',
'optionErrors' => [
],
'stackTrace' => [
'<unknown>'
],
'statusCode' => 123,
'validationErrors' => [
[
'description' => '<string>',
'message' => '<string>',
'option' => '<string>'
]
]
],
'id' => '<string>',
'idempotencyKey' => '<string>',
'organizationId' => '<string>',
'parentExecutionId' => '<string>',
'pipeline' => [
'exceptions' => [
[
'advice' => '<string>',
'cause' => '<unknown>',
'description' => '<string>',
'documentationUrl' => '<string>',
'errorMessage' => '<string>',
'errorType' => '<string>',
'executedVersion' => '<string>',
'help' => '<string>',
'message' => '<string>',
'optionErrors' => [
],
'stackTrace' => [
'<unknown>'
],
'statusCode' => 123,
'validationErrors' => [
[
'description' => '<string>',
'message' => '<string>',
'option' => '<string>'
]
]
]
],
'id' => '<string>',
'ref' => '<string>',
'steps' => [
[
'conditional' => '<string>',
'context' => [
],
'end' => '<string>',
'exceptionDetails' => [
'advice' => '<string>',
'cause' => '<unknown>',
'description' => '<string>',
'documentationUrl' => '<string>',
'errorMessage' => '<string>',
'errorType' => '<string>',
'executedVersion' => '<string>',
'help' => '<string>',
'message' => '<string>',
'optionErrors' => [
],
'stackTrace' => [
'<unknown>'
],
'statusCode' => 123,
'validationErrors' => [
[
'description' => '<string>',
'message' => '<string>',
'option' => '<string>'
]
]
],
'executionPolicy' => [
'backoffBaseSeconds' => 123,
'backoffStrategy' => '<string>',
'maxAttempts' => 123,
'onExhausted' => '<string>',
'timeoutSeconds' => 123
],
'extensionPackRef' => '<string>',
'id' => '<string>',
'inputId' => '<string>',
'name' => '<string>',
'optionTypes' => [
],
'options' => [
],
'outputId' => '<string>',
'outputIds' => '<string>',
'processingTime' => 123,
'progress' => 123,
'progressMax' => 123,
'ref' => '<string>',
'start' => '<string>',
'statusMessage' => '<string>',
'stepType' => 'MODULE'
]
],
'valid' => true
],
'priority' => 123,
'processingTime' => 123,
'sessionId' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'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' => '<string>',
'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>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://platform.kodexa.ai/api/document-families/{id}"
payload := strings.NewReader("{\n \"changeSequence\": 123,\n \"contentObjects\": [\n {\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"documentStatus\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"executionTargets\": {\n \"instances\": [\n {\n \"actor\": {\n \"actorId\": \"<string>\"\n },\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"b1234567-89ab-cdef-0123-456789abcdef\",\n \"locked\": true,\n \"metadata\": {},\n \"metadataSource\": {},\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"originalPath\": \"<string>\",\n \"path\": \"invoices/2025/q4/invoice-001.pdf\",\n \"pendingProcessing\": true,\n \"size\": 245760,\n \"statistics\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"recentExecutions\": [\n {\n \"assistant\": {\n \"active\": true,\n \"assistantRole\": \"<string>\",\n \"changeSequence\": 123,\n \"chatEnabled\": true,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"e4567890-12ab-cdef-3456-789012abcdef\",\n \"name\": \"Invoice Extractor\",\n \"options\": {\n \"agentRuntimeId\": \"<string>\",\n \"complete_label\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"pipeline\": {\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"name\": \"<string>\",\n \"options\": {},\n \"ref\": \"<string>\",\n \"stepType\": \"<string>\"\n }\n ]\n },\n \"prompt\": \"<string>\",\n \"taxonomies\": [\n \"<string>\"\n ]\n },\n \"priorityHint\": 123,\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"runOnExistingContent\": true,\n \"showInTraining\": true,\n \"slug\": \"invoice-extractor\",\n \"subscription\": \"<string>\",\n \"testOptions\": {},\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"validationErrors\": {\n \"instances\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"execution\": {\n \"assistantId\": \"<string>\",\n \"changeSequence\": 123,\n \"context\": {},\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"parentExecutionId\": \"<string>\",\n \"pipeline\": {\n \"exceptions\": [\n {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n ],\n \"id\": \"<string>\",\n \"ref\": \"<string>\",\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"context\": {},\n \"end\": \"<string>\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"inputId\": \"<string>\",\n \"name\": \"<string>\",\n \"optionTypes\": {},\n \"options\": {},\n \"outputId\": \"<string>\",\n \"outputIds\": \"<string>\",\n \"processingTime\": 123,\n \"progress\": 123,\n \"progressMax\": 123,\n \"ref\": \"<string>\",\n \"start\": \"<string>\",\n \"statusMessage\": \"<string>\",\n \"stepType\": \"MODULE\"\n }\n ],\n \"valid\": true\n },\n \"priority\": 123,\n \"processingTime\": 123,\n \"sessionId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"statusDetails\": {\n \"detail\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": 123,\n \"progressMax\": 123,\n \"stepStatus\": \"<string>\"\n },\n \"targets\": {\n \"instances\": [\n {\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://platform.kodexa.ai/api/document-families/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"changeSequence\": 123,\n \"contentObjects\": [\n {\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"documentStatus\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"executionTargets\": {\n \"instances\": [\n {\n \"actor\": {\n \"actorId\": \"<string>\"\n },\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"b1234567-89ab-cdef-0123-456789abcdef\",\n \"locked\": true,\n \"metadata\": {},\n \"metadataSource\": {},\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"originalPath\": \"<string>\",\n \"path\": \"invoices/2025/q4/invoice-001.pdf\",\n \"pendingProcessing\": true,\n \"size\": 245760,\n \"statistics\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"recentExecutions\": [\n {\n \"assistant\": {\n \"active\": true,\n \"assistantRole\": \"<string>\",\n \"changeSequence\": 123,\n \"chatEnabled\": true,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"e4567890-12ab-cdef-3456-789012abcdef\",\n \"name\": \"Invoice Extractor\",\n \"options\": {\n \"agentRuntimeId\": \"<string>\",\n \"complete_label\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"pipeline\": {\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"name\": \"<string>\",\n \"options\": {},\n \"ref\": \"<string>\",\n \"stepType\": \"<string>\"\n }\n ]\n },\n \"prompt\": \"<string>\",\n \"taxonomies\": [\n \"<string>\"\n ]\n },\n \"priorityHint\": 123,\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"runOnExistingContent\": true,\n \"showInTraining\": true,\n \"slug\": \"invoice-extractor\",\n \"subscription\": \"<string>\",\n \"testOptions\": {},\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"validationErrors\": {\n \"instances\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"execution\": {\n \"assistantId\": \"<string>\",\n \"changeSequence\": 123,\n \"context\": {},\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"parentExecutionId\": \"<string>\",\n \"pipeline\": {\n \"exceptions\": [\n {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n ],\n \"id\": \"<string>\",\n \"ref\": \"<string>\",\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"context\": {},\n \"end\": \"<string>\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"inputId\": \"<string>\",\n \"name\": \"<string>\",\n \"optionTypes\": {},\n \"options\": {},\n \"outputId\": \"<string>\",\n \"outputIds\": \"<string>\",\n \"processingTime\": 123,\n \"progress\": 123,\n \"progressMax\": 123,\n \"ref\": \"<string>\",\n \"start\": \"<string>\",\n \"statusMessage\": \"<string>\",\n \"stepType\": \"MODULE\"\n }\n ],\n \"valid\": true\n },\n \"priority\": 123,\n \"processingTime\": 123,\n \"sessionId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"statusDetails\": {\n \"detail\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": 123,\n \"progressMax\": 123,\n \"stepStatus\": \"<string>\"\n },\n \"targets\": {\n \"instances\": [\n {\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://platform.kodexa.ai/api/document-families/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"changeSequence\": 123,\n \"contentObjects\": [\n {\n \"changeSequence\": 123,\n \"contentMetadata\": {},\n \"contentType\": 123,\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"docTransitionType\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"documentVersion\": \"<string>\",\n \"id\": \"<string>\",\n \"index\": 123,\n \"metadata\": {},\n \"mixins\": [\n \"<string>\"\n ],\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"name\": \"<string>\",\n \"size\": 123,\n \"source\": {\n \"checksum\": \"<string>\",\n \"cid\": \"<string>\",\n \"connector\": \"<string>\",\n \"created\": \"<string>\",\n \"document_family_id\": \"<string>\",\n \"headers\": {},\n \"last_modified\": \"<string>\",\n \"lineage_document_uuid\": \"<string>\",\n \"mime_type\": \"<string>\",\n \"original_filename\": \"<string>\",\n \"original_path\": \"<string>\",\n \"source_document_uuid\": \"<string>\"\n },\n \"sourceContentObjectId\": \"<string>\",\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"created\": \"2023-11-07T05:31:56Z\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleteUserEmail\": \"<string>\",\n \"deleted\": true,\n \"deletedDate\": \"2023-11-07T05:31:56Z\",\n \"documentStatus\": \"<string>\",\n \"documentTaxonValidations\": [\n {\n \"taxonPath\": \"<string>\",\n \"taxonomyRef\": \"<string>\",\n \"validation\": {\n \"conditional\": true,\n \"conditionalFormula\": \"<string>\",\n \"description\": \"<string>\",\n \"detailFormula\": \"<string>\",\n \"disabled\": true,\n \"exceptionId\": \"<string>\",\n \"messageFormula\": \"<string>\",\n \"name\": \"<string>\",\n \"overridable\": true,\n \"ruleFormula\": \"<string>\",\n \"supportArticleId\": \"<string>\"\n }\n }\n ],\n \"executionTargets\": {\n \"instances\": [\n {\n \"actor\": {\n \"actorId\": \"<string>\"\n },\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ]\n }\n ]\n },\n \"id\": \"b1234567-89ab-cdef-0123-456789abcdef\",\n \"locked\": true,\n \"metadata\": {},\n \"metadataSource\": {},\n \"modified\": \"2023-11-07T05:31:56Z\",\n \"originalPath\": \"<string>\",\n \"path\": \"invoices/2025/q4/invoice-001.pdf\",\n \"pendingProcessing\": true,\n \"size\": 245760,\n \"statistics\": {\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"id\": \"<string>\",\n \"recentExecutions\": [\n {\n \"assistant\": {\n \"active\": true,\n \"assistantRole\": \"<string>\",\n \"changeSequence\": 123,\n \"chatEnabled\": true,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"deleted\": true,\n \"description\": \"<string>\",\n \"id\": \"e4567890-12ab-cdef-3456-789012abcdef\",\n \"name\": \"Invoice Extractor\",\n \"options\": {\n \"agentRuntimeId\": \"<string>\",\n \"complete_label\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"pipeline\": {\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"name\": \"<string>\",\n \"options\": {},\n \"ref\": \"<string>\",\n \"stepType\": \"<string>\"\n }\n ]\n },\n \"prompt\": \"<string>\",\n \"taxonomies\": [\n \"<string>\"\n ]\n },\n \"priorityHint\": 123,\n \"project\": {\n \"changeSequence\": 123,\n \"color\": \"#4A90D9\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"dataFlow\": {\n \"edges\": [\n {\n \"id\": \"<string>\",\n \"properties\": {},\n \"source\": \"<string>\",\n \"target\": \"<string>\"\n }\n ],\n \"nodes\": [\n {\n \"dimensions\": {\n \"height\": 123,\n \"width\": 123\n },\n \"id\": \"<string>\",\n \"parentId\": \"<string>\",\n \"position\": {\n \"x\": 123,\n \"y\": 123\n },\n \"properties\": {},\n \"type\": \"<string>\"\n }\n ],\n \"viewPort\": {\n \"x\": 123,\n \"y\": 123,\n \"zoom\": 123\n }\n },\n \"description\": \"Automated invoice processing pipeline.\",\n \"documentStatuses\": [\n {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"project\": \"<unknown>\",\n \"projectId\": \"<string>\",\n \"slug\": \"<string>\",\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n \"memory\": {\n \"changeSequence\": 123,\n \"orderedDashboards\": [\n \"<string>\"\n ],\n \"recentFilters\": {},\n \"recentQueries\": {}\n },\n \"name\": \"Invoice Processing\",\n \"notes\": \"<string>\",\n \"options\": {\n \"companion\": {\n \"agentRuntimeRef\": \"<string>\",\n \"moduleRefs\": [\n \"<string>\"\n ],\n \"prompt\": \"<string>\"\n },\n \"dataOptions\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"dataProperties\": {},\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"groupTaxonTypeFeatures\": {},\n \"options\": [\n {\n \"aliases\": [\n \"<string>\"\n ],\n \"default\": \"<unknown>\",\n \"description\": \"<string>\",\n \"developerOnly\": true,\n \"displayProperties\": {},\n \"falseLabel\": \"<string>\",\n \"featureFlag\": \"<string>\",\n \"groupOptions\": \"<array>\",\n \"hint\": \"<string>\",\n \"label\": \"<string>\",\n \"listDescription\": \"<string>\",\n \"listLabel\": \"<string>\",\n \"listType\": \"<string>\",\n \"name\": \"<string>\",\n \"overviewMarkdown\": \"<string>\",\n \"possibleValues\": [\n {\n \"description\": \"<string>\",\n \"label\": \"<string>\",\n \"value\": \"<unknown>\"\n }\n ],\n \"properties\": {},\n \"required\": true,\n \"showIf\": \"<string>\",\n \"showOnPopup\": true,\n \"subType\": \"<string>\",\n \"supportArticle\": \"<string>\",\n \"tabName\": \"<string>\",\n \"type\": \"<string>\"\n }\n ],\n \"properties\": {},\n \"taskOptions\": {\n \"showNewTask\": true\n },\n \"taxonTypeFeatures\": {}\n },\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"owner\": {\n \"active\": true,\n \"bio\": \"<string>\",\n \"businessGroup\": \"<string>\",\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"groupsJson\": \"<string>\",\n \"id\": \"<string>\",\n \"image\": \"<string>\",\n \"isExternallyManaged\": true,\n \"lastName\": \"<string>\",\n \"preferences\": {\n \"showOnboarding\": true,\n \"showScrollbars\": true,\n \"showWelcomeMessage\": true\n },\n \"rolesJson\": \"<string>\",\n \"searchText\": \"<string>\",\n \"security\": {\n \"roles\": [\n \"<string>\"\n ]\n },\n \"showDeveloperTools\": true,\n \"title\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"userStorage\": {\n \"favoriteLinks\": [\n {\n \"link\": \"<string>\"\n }\n ]\n },\n \"userType\": \"<string>\",\n \"uuid\": \"<string>\"\n },\n \"ownerId\": \"<string>\",\n \"projectTemplateRef\": \"<string>\",\n \"searchText\": \"<string>\",\n \"slug\": \"invoice-processing\",\n \"status\": {\n \"changeSequence\": 123,\n \"color\": \"<string>\",\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"organization\": {\n \"archived\": true,\n \"authGroupLink\": {\n \"authGroup\": \"<string>\"\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"defaultToPrivateTemplates\": true,\n \"description\": \"Document processing organization for Acme Corp.\",\n \"enterpriseOrganization\": true,\n \"features\": {},\n \"hasImage\": true,\n \"id\": \"550e8400-e29b-41d4-a716-446655440000\",\n \"memory\": {\n \"orderedDashboards\": [\n \"<string>\"\n ]\n },\n \"name\": \"Acme Corp\",\n \"organizationStatus\": \"ACTIVE\",\n \"properties\": {},\n \"publicAccess\": true,\n \"searchText\": \"<string>\",\n \"slug\": \"acme-corp\",\n \"stripeCustomerId\": \"<string>\",\n \"supportAccess\": true,\n \"supportAccessExpiresAt\": \"2023-11-07T05:31:56Z\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"550e8400e29b41d4a716446655440000\"\n },\n \"organizationId\": \"<string>\",\n \"production\": true,\n \"status\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"statusId\": \"<string>\",\n \"statusType\": \"ACTIVE\",\n \"templateArticleId\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"7c9e667974254de944be07fc1f90ae7\"\n },\n \"projectId\": \"<string>\",\n \"runOnExistingContent\": true,\n \"showInTraining\": true,\n \"slug\": \"invoice-extractor\",\n \"subscription\": \"<string>\",\n \"testOptions\": {},\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\",\n \"validationErrors\": {\n \"instances\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n },\n \"changeSequence\": 123,\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"execution\": {\n \"assistantId\": \"<string>\",\n \"changeSequence\": 123,\n \"context\": {},\n \"createdOn\": \"2023-11-07T05:31:56Z\",\n \"description\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"id\": \"<string>\",\n \"idempotencyKey\": \"<string>\",\n \"organizationId\": \"<string>\",\n \"parentExecutionId\": \"<string>\",\n \"pipeline\": {\n \"exceptions\": [\n {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n }\n ],\n \"id\": \"<string>\",\n \"ref\": \"<string>\",\n \"steps\": [\n {\n \"conditional\": \"<string>\",\n \"context\": {},\n \"end\": \"<string>\",\n \"exceptionDetails\": {\n \"advice\": \"<string>\",\n \"cause\": \"<unknown>\",\n \"description\": \"<string>\",\n \"documentationUrl\": \"<string>\",\n \"errorMessage\": \"<string>\",\n \"errorType\": \"<string>\",\n \"executedVersion\": \"<string>\",\n \"help\": \"<string>\",\n \"message\": \"<string>\",\n \"optionErrors\": {},\n \"stackTrace\": [\n \"<unknown>\"\n ],\n \"statusCode\": 123,\n \"validationErrors\": [\n {\n \"description\": \"<string>\",\n \"message\": \"<string>\",\n \"option\": \"<string>\"\n }\n ]\n },\n \"executionPolicy\": {\n \"backoffBaseSeconds\": 123,\n \"backoffStrategy\": \"<string>\",\n \"maxAttempts\": 123,\n \"onExhausted\": \"<string>\",\n \"timeoutSeconds\": 123\n },\n \"extensionPackRef\": \"<string>\",\n \"id\": \"<string>\",\n \"inputId\": \"<string>\",\n \"name\": \"<string>\",\n \"optionTypes\": {},\n \"options\": {},\n \"outputId\": \"<string>\",\n \"outputIds\": \"<string>\",\n \"processingTime\": 123,\n \"progress\": 123,\n \"progressMax\": 123,\n \"ref\": \"<string>\",\n \"start\": \"<string>\",\n \"statusMessage\": \"<string>\",\n \"stepType\": \"MODULE\"\n }\n ],\n \"valid\": true\n },\n \"priority\": 123,\n \"processingTime\": 123,\n \"sessionId\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"statusDetails\": {\n \"detail\": \"<string>\",\n \"message\": \"<string>\",\n \"progress\": 123,\n \"progressMax\": 123,\n \"stepStatus\": \"<string>\"\n },\n \"targets\": {\n \"instances\": [\n {\n \"contentObjectId\": \"<string>\",\n \"documentFamilyId\": \"<string>\",\n \"labelsToApply\": [\n \"<string>\"\n ],\n \"ref\": \"<string>\",\n \"taxonomyRefs\": [\n \"<string>\"\n ],\n \"type\": \"<string>\"\n }\n ]\n },\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"id\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n }\n ],\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n },\n \"storeRef\": \"<string>\",\n \"summary\": \"<string>\",\n \"updatedOn\": \"2023-11-07T05:31:56Z\",\n \"uuid\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"changeSequence": 123,
"contentObjects": [
{
"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>"
}
],
"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>"
},
"contentObjectId": "<string>",
"documentFamilyId": "<string>",
"labelsToApply": [
"<string>"
],
"ref": "<string>",
"taxonomyRefs": [
"<string>"
]
}
]
},
"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": "<string>",
"recentExecutions": [
{
"assistant": {
"active": true,
"assistantRole": "<string>",
"changeSequence": 123,
"chatEnabled": true,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"deleted": true,
"description": "<string>",
"id": "e4567890-12ab-cdef-3456-789012abcdef",
"name": "Invoice Extractor",
"options": {
"agentRuntimeId": "<string>",
"complete_label": "<string>",
"moduleRefs": [
"<string>"
],
"pipeline": {
"steps": [
{
"conditional": "<string>",
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"name": "<string>",
"options": {},
"ref": "<string>",
"stepType": "<string>"
}
]
},
"prompt": "<string>",
"taxonomies": [
"<string>"
]
},
"priorityHint": 123,
"project": {
"changeSequence": 123,
"color": "#4A90D9",
"createdOn": "2023-11-07T05:31:56Z",
"dataFlow": {
"edges": [
{
"id": "<string>",
"properties": {},
"source": "<string>",
"target": "<string>"
}
],
"nodes": [
{
"dimensions": {
"height": 123,
"width": 123
},
"id": "<string>",
"parentId": "<string>",
"position": {
"x": 123,
"y": 123
},
"properties": {},
"type": "<string>"
}
],
"viewPort": {
"x": 123,
"y": 123,
"zoom": 123
}
},
"description": "Automated invoice processing pipeline.",
"documentStatuses": [
{
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"project": "<unknown>",
"projectId": "<string>",
"slug": "<string>",
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
}
],
"id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
"memory": {
"changeSequence": 123,
"orderedDashboards": [
"<string>"
],
"recentFilters": {},
"recentQueries": {}
},
"name": "Invoice Processing",
"notes": "<string>",
"options": {
"companion": {
"agentRuntimeRef": "<string>",
"moduleRefs": [
"<string>"
],
"prompt": "<string>"
},
"dataOptions": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"dataProperties": {},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"groupTaxonTypeFeatures": {},
"options": [
{
"aliases": [
"<string>"
],
"default": "<unknown>",
"description": "<string>",
"developerOnly": true,
"displayProperties": {},
"falseLabel": "<string>",
"featureFlag": "<string>",
"groupOptions": "<array>",
"hint": "<string>",
"label": "<string>",
"listDescription": "<string>",
"listLabel": "<string>",
"listType": "<string>",
"name": "<string>",
"overviewMarkdown": "<string>",
"possibleValues": [
{
"description": "<string>",
"label": "<string>",
"value": "<unknown>"
}
],
"properties": {},
"required": true,
"showIf": "<string>",
"showOnPopup": true,
"subType": "<string>",
"supportArticle": "<string>",
"tabName": "<string>",
"type": "<string>"
}
],
"properties": {},
"taskOptions": {
"showNewTask": true
},
"taxonTypeFeatures": {}
},
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"owner": {
"active": true,
"bio": "<string>",
"businessGroup": "<string>",
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"email": "<string>",
"firstName": "<string>",
"groupsJson": "<string>",
"id": "<string>",
"image": "<string>",
"isExternallyManaged": true,
"lastName": "<string>",
"preferences": {
"showOnboarding": true,
"showScrollbars": true,
"showWelcomeMessage": true
},
"rolesJson": "<string>",
"searchText": "<string>",
"security": {
"roles": [
"<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": "invoice-processing",
"status": {
"changeSequence": 123,
"color": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"icon": "<string>",
"id": "<string>",
"organization": {
"archived": true,
"authGroupLink": {
"authGroup": "<string>"
},
"changeSequence": 123,
"createdOn": "2023-11-07T05:31:56Z",
"defaultToPrivateTemplates": true,
"description": "Document processing organization for Acme Corp.",
"enterpriseOrganization": true,
"features": {},
"hasImage": true,
"id": "550e8400-e29b-41d4-a716-446655440000",
"memory": {
"orderedDashboards": [
"<string>"
]
},
"name": "Acme Corp",
"organizationStatus": "ACTIVE",
"properties": {},
"publicAccess": true,
"searchText": "<string>",
"slug": "acme-corp",
"stripeCustomerId": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "550e8400e29b41d4a716446655440000"
},
"organizationId": "<string>",
"production": true,
"status": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "<string>"
},
"statusId": "<string>",
"statusType": "ACTIVE",
"templateArticleId": "<string>",
"updatedOn": "2023-11-07T05:31:56Z",
"uuid": "7c9e667974254de944be07fc1f90ae7"
},
"projectId": "<string>",
"runOnExistingContent": true,
"showInTraining": true,
"slug": "invoice-extractor",
"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",
"description": "<string>",
"documentFamilyId": "<string>",
"endDate": "2023-11-07T05:31:56Z",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"id": "<string>",
"idempotencyKey": "<string>",
"organizationId": "<string>",
"parentExecutionId": "<string>",
"pipeline": {
"exceptions": [
{
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
}
],
"id": "<string>",
"ref": "<string>",
"steps": [
{
"conditional": "<string>",
"context": {},
"end": "<string>",
"exceptionDetails": {
"advice": "<string>",
"cause": "<unknown>",
"description": "<string>",
"documentationUrl": "<string>",
"errorMessage": "<string>",
"errorType": "<string>",
"executedVersion": "<string>",
"help": "<string>",
"message": "<string>",
"optionErrors": {},
"stackTrace": [
"<unknown>"
],
"statusCode": 123,
"validationErrors": [
{
"description": "<string>",
"message": "<string>",
"option": "<string>"
}
]
},
"executionPolicy": {
"backoffBaseSeconds": 123,
"backoffStrategy": "<string>",
"maxAttempts": 123,
"onExhausted": "<string>",
"timeoutSeconds": 123
},
"extensionPackRef": "<string>",
"id": "<string>",
"inputId": "<string>",
"name": "<string>",
"optionTypes": {},
"options": {},
"outputId": "<string>",
"outputIds": "<string>",
"processingTime": 123,
"progress": 123,
"progressMax": 123,
"ref": "<string>",
"start": "<string>",
"statusMessage": "<string>",
"stepType": "MODULE"
}
],
"valid": true
},
"priority": 123,
"processingTime": 123,
"sessionId": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"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": "<string>",
"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-keybearerAuth
API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.
Path Parameters
Unique identifier (UUID) of the resource.
Body
application/json
A document family groups related content objects representing a single logical document, tracking its processing lifecycle.
Optimistic locking version number.
Content objects belonging to this document family, ordered by index.
Show child attributes
Show child attributes
Original file creation date.
Timestamp when the document family was created.
Email of the user who deleted the document family.
Whether the document family has been soft-deleted.
Timestamp when the document family was soft-deleted.
Current processing status of the document.
Validation results against the document taxonomy.
Show child attributes
Show child attributes
Processing execution targets for this document.
Show child attributes
Show child attributes
Unique identifier (UUID) for the document family.
Example:
"b1234567-89ab-cdef-0123-456789abcdef"
Whether the document family is locked for processing.
Document metadata extracted during processing.
Show child attributes
Show child attributes
Maps metadata keys to their source content object IDs.
Show child attributes
Show child attributes
Original file modification date.
Original path before soft-deletion or rename.
File path or name of the document.
Example:
"invoices/2025/q4/invoice-001.pdf"
Whether the document family is queued for processing.
File size in bytes.
Example:
245760
Document family statistics contain processing metrics for a document family.
Show child attributes
Show child attributes
Reference to the document store containing this document family.
AI-generated summary of the document content.
Timestamp when the document family was last updated.
Secondary UUID identifier.
Response
Updated DocumentFamily
A document family groups related content objects representing a single logical document, tracking its processing lifecycle.
Optimistic locking version number.
Content objects belonging to this document family, ordered by index.
Show child attributes
Show child attributes
Original file creation date.
Timestamp when the document family was created.
Email of the user who deleted the document family.
Whether the document family has been soft-deleted.
Timestamp when the document family was soft-deleted.
Current processing status of the document.
Validation results against the document taxonomy.
Show child attributes
Show child attributes
Processing execution targets for this document.
Show child attributes
Show child attributes
Unique identifier (UUID) for the document family.
Example:
"b1234567-89ab-cdef-0123-456789abcdef"
Whether the document family is locked for processing.
Document metadata extracted during processing.
Show child attributes
Show child attributes
Maps metadata keys to their source content object IDs.
Show child attributes
Show child attributes
Original file modification date.
Original path before soft-deletion or rename.
File path or name of the document.
Example:
"invoices/2025/q4/invoice-001.pdf"
Whether the document family is queued for processing.
File size in bytes.
Example:
245760
Document family statistics contain processing metrics for a document family.
Show child attributes
Show child attributes
Reference to the document store containing this document family.
AI-generated summary of the document content.
Timestamp when the document family was last updated.
Secondary UUID identifier.
⌘I