Skip to main content
POST
/
api
/
executions
Create Execution
curl --request POST \
  --url https://platform.kodexa.ai/api/executions \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "assistantId": "<string>",
  "changeSequence": 123,
  "context": {},
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteLoggingOnSuccess": true,
  "description": "<string>",
  "documentFamilyId": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "exceptionDetails": {
    "advice": "<string>",
    "cause": {},
    "description": "<string>",
    "documentationUrl": "<string>",
    "errorMessage": "<string>",
    "errorType": "<string>",
    "executedVersion": "<string>",
    "help": "<string>",
    "message": "<string>",
    "optionErrors": {},
    "stackTrace": [
      {}
    ],
    "statusCode": 123,
    "validationErrors": [
      {
        "description": "<string>",
        "message": "<string>",
        "option": "<string>"
      }
    ]
  },
  "id": "<string>",
  "loggingEnabled": true,
  "organizationId": "<string>",
  "parentExecutionId": "<string>",
  "pipeline": {
    "exceptions": [
      {
        "advice": "<string>",
        "cause": {},
        "description": "<string>",
        "documentationUrl": "<string>",
        "errorMessage": "<string>",
        "errorType": "<string>",
        "executedVersion": "<string>",
        "help": "<string>",
        "message": "<string>",
        "optionErrors": {},
        "stackTrace": [
          {}
        ],
        "statusCode": 123,
        "validationErrors": [
          {
            "description": "<string>",
            "message": "<string>",
            "option": "<string>"
          }
        ]
      }
    ],
    "id": "<string>",
    "ref": "<string>",
    "steps": [
      {
        "conditional": "<string>",
        "context": {},
        "end": "<string>",
        "exceptionDetails": {
          "advice": "<string>",
          "cause": {},
          "description": "<string>",
          "documentationUrl": "<string>",
          "errorMessage": "<string>",
          "errorType": "<string>",
          "executedVersion": "<string>",
          "help": "<string>",
          "message": "<string>",
          "optionErrors": {},
          "stackTrace": [
            {}
          ],
          "statusCode": 123,
          "validationErrors": [
            {
              "description": "<string>",
              "message": "<string>",
              "option": "<string>"
            }
          ]
        },
        "extensionPackRef": "<string>",
        "id": "<string>",
        "inputId": "<string>",
        "name": "<string>",
        "optionTypes": {},
        "options": {},
        "outputId": "<string>",
        "outputIds": "<string>",
        "processingTime": 123,
        "progress": 123,
        "progressMax": 123,
        "ref": "<string>",
        "start": "<string>",
        "status": "<string>",
        "statusMessage": "<string>",
        "stepType": "<string>"
      }
    ],
    "valid": true
  },
  "priority": 123,
  "processingTime": 123,
  "sessionId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "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>"
}
'
{
  "assistantId": "<string>",
  "changeSequence": 123,
  "context": {},
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteLoggingOnSuccess": true,
  "description": "<string>",
  "documentFamilyId": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "exceptionDetails": {
    "advice": "<string>",
    "cause": {},
    "description": "<string>",
    "documentationUrl": "<string>",
    "errorMessage": "<string>",
    "errorType": "<string>",
    "executedVersion": "<string>",
    "help": "<string>",
    "message": "<string>",
    "optionErrors": {},
    "stackTrace": [
      {}
    ],
    "statusCode": 123,
    "validationErrors": [
      {
        "description": "<string>",
        "message": "<string>",
        "option": "<string>"
      }
    ]
  },
  "id": "<string>",
  "loggingEnabled": true,
  "organizationId": "<string>",
  "parentExecutionId": "<string>",
  "pipeline": {
    "exceptions": [
      {
        "advice": "<string>",
        "cause": {},
        "description": "<string>",
        "documentationUrl": "<string>",
        "errorMessage": "<string>",
        "errorType": "<string>",
        "executedVersion": "<string>",
        "help": "<string>",
        "message": "<string>",
        "optionErrors": {},
        "stackTrace": [
          {}
        ],
        "statusCode": 123,
        "validationErrors": [
          {
            "description": "<string>",
            "message": "<string>",
            "option": "<string>"
          }
        ]
      }
    ],
    "id": "<string>",
    "ref": "<string>",
    "steps": [
      {
        "conditional": "<string>",
        "context": {},
        "end": "<string>",
        "exceptionDetails": {
          "advice": "<string>",
          "cause": {},
          "description": "<string>",
          "documentationUrl": "<string>",
          "errorMessage": "<string>",
          "errorType": "<string>",
          "executedVersion": "<string>",
          "help": "<string>",
          "message": "<string>",
          "optionErrors": {},
          "stackTrace": [
            {}
          ],
          "statusCode": 123,
          "validationErrors": [
            {
              "description": "<string>",
              "message": "<string>",
              "option": "<string>"
            }
          ]
        },
        "extensionPackRef": "<string>",
        "id": "<string>",
        "inputId": "<string>",
        "name": "<string>",
        "optionTypes": {},
        "options": {},
        "outputId": "<string>",
        "outputIds": "<string>",
        "processingTime": 123,
        "progress": 123,
        "progressMax": 123,
        "ref": "<string>",
        "start": "<string>",
        "status": "<string>",
        "statusMessage": "<string>",
        "stepType": "<string>"
      }
    ],
    "valid": true
  },
  "priority": 123,
  "processingTime": 123,
  "sessionId": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "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>"
}

Authorizations

​
x-api-key
string
header
required

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

Body

application/json

An execution records the details and results of a processing session.

​
assistantId
string | null
​
changeSequence
integer<int32>

Optimistic locking version number.

​
context
object
​
createdOn
string<date-time>

Timestamp when the execution was created.

​
deleteLoggingOnSuccess
boolean | null
​
description
string
​
documentFamilyId
string | null
​
endDate
string<date-time> | null
​
exceptionDetails
object
​
id
string

Unique identifier (UUID) for the execution.

​
loggingEnabled
boolean | null
​
organizationId
string | null
​
parentExecutionId
string | null
​
pipeline
object
​
priority
integer<int32>
​
processingTime
integer<int64>
​
sessionId
string | null
​
startDate
string<date-time> | null
​
status
string
​
statusDetails
object
​
targets
object
​
updatedOn
string<date-time>

Timestamp when the execution was last updated.

​
uuid
string

Secondary UUID identifier.

Response

Created Execution

An execution records the details and results of a processing session.

​
assistantId
string | null
​
changeSequence
integer<int32>

Optimistic locking version number.

​
context
object
​
createdOn
string<date-time>

Timestamp when the execution was created.

​
deleteLoggingOnSuccess
boolean | null
​
description
string
​
documentFamilyId
string | null
​
endDate
string<date-time> | null
​
exceptionDetails
object
​
id
string

Unique identifier (UUID) for the execution.

​
loggingEnabled
boolean | null
​
organizationId
string | null
​
parentExecutionId
string | null
​
pipeline
object
​
priority
integer<int32>
​
processingTime
integer<int64>
​
sessionId
string | null
​
startDate
string<date-time> | null
​
status
string
​
statusDetails
object
​
targets
object
​
updatedOn
string<date-time>

Timestamp when the execution was last updated.

​
uuid
string

Secondary UUID identifier.