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",
  "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>"
}
'
import requests

url = "https://platform.kodexa.ai/api/executions"

payload = {
    "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>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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>'
  })
};

fetch('https://platform.kodexa.ai/api/executions', 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/executions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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>'
  ]),
  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/executions"

	payload := strings.NewReader("{\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}")

	req, _ := http.NewRequest("POST", 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.post("https://platform.kodexa.ai/api/executions")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\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}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/executions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\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}"

response = http.request(request)
puts response.read_body
{
  "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>"
}

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.

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

Unique identifier (UUID) for the execution.

​
idempotencyKey
string | null
​
organizationId
string
​
parentExecutionId
string | null
​
pipeline
object | null
​
priority
integer<int32>
​
processingTime
integer<int64>
​
sessionId
string | null
​
startDate
string<date-time> | null
​
status
enum<string>
Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED,
REQUESTED,
SKIPPED,
CANCELLING,
CANCELLED,
PENDING_REPROCESSING,
REPROCESSED
​
statusDetails
object | null
​
targets
object | null
​
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.

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

Unique identifier (UUID) for the execution.

​
idempotencyKey
string | null
​
organizationId
string
​
parentExecutionId
string | null
​
pipeline
object | null
​
priority
integer<int32>
​
processingTime
integer<int64>
​
sessionId
string | null
​
startDate
string<date-time> | null
​
status
enum<string>
Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED,
REQUESTED,
SKIPPED,
CANCELLING,
CANCELLED,
PENDING_REPROCESSING,
REPROCESSED
​
statusDetails
object | null
​
targets
object | null
​
updatedOn
string<date-time>

Timestamp when the execution was last updated.

​
uuid
string

Secondary UUID identifier.