Skip to main content
POST
/
api
/
orchestrator-modules
Create OrchestratorModule
curl --request POST \
  --url https://platform.kodexa.ai/api/orchestrator-modules \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "actions": "<unknown>",
    "additionalTaxonOptions": "<unknown>",
    "allowedHosts": [
      "<string>"
    ],
    "baseDir": "<string>",
    "bridgeType": "<string>",
    "contents": [
      "<string>"
    ],
    "eventAware": true,
    "ignoredContents": [
      "<string>"
    ],
    "inferable": true,
    "inferenceOptions": "<unknown>",
    "messageTemplates": "<unknown>",
    "moduleRuntimeParameters": {},
    "moduleRuntimeRef": "<string>",
    "moduleSidecars": [
      "<string>"
    ],
    "optionTabs": "<unknown>",
    "script": "<string>",
    "scriptLanguage": "<string>",
    "state": "<string>",
    "stateHash": "<string>",
    "supportsScheduling": true,
    "taxonFeatures": "<unknown>",
    "taxonomy": "<unknown>",
    "type": "<string>"
  },
  "moduleStatus": "<string>",
  "moduleType": "<string>",
  "name": "<string>",
  "organization": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "supportsScheduling": true,
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}
'
import requests

url = "https://platform.kodexa.ai/api/orchestrator-modules"

payload = {
    "changeSequence": 123,
    "createdBy": "<string>",
    "createdOn": "2023-11-07T05:31:56Z",
    "deleteUserEmail": "<string>",
    "deleteUserId": "<string>",
    "deleted": True,
    "deletedDate": "2023-11-07T05:31:56Z",
    "deprecated": True,
    "description": "<string>",
    "eventAware": True,
    "extensionPackRef": "<string>",
    "id": "<string>",
    "metadata": {
        "actions": "<unknown>",
        "additionalTaxonOptions": "<unknown>",
        "allowedHosts": ["<string>"],
        "baseDir": "<string>",
        "bridgeType": "<string>",
        "contents": ["<string>"],
        "eventAware": True,
        "ignoredContents": ["<string>"],
        "inferable": True,
        "inferenceOptions": "<unknown>",
        "messageTemplates": "<unknown>",
        "moduleRuntimeParameters": {},
        "moduleRuntimeRef": "<string>",
        "moduleSidecars": ["<string>"],
        "optionTabs": "<unknown>",
        "script": "<string>",
        "scriptLanguage": "<string>",
        "state": "<string>",
        "stateHash": "<string>",
        "supportsScheduling": True,
        "taxonFeatures": "<unknown>",
        "taxonomy": "<unknown>",
        "type": "<string>"
    },
    "moduleStatus": "<string>",
    "moduleType": "<string>",
    "name": "<string>",
    "organization": {
        "changeSequence": 123,
        "createdOn": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "name": "<string>",
        "slug": "<string>",
        "updatedOn": "2023-11-07T05:31:56Z",
        "uuid": "<string>"
    },
    "organizationId": "<string>",
    "publicAccess": True,
    "slug": "<string>",
    "supportsScheduling": True,
    "template": True,
    "type": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>",
    "yamlSource": "<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({
    changeSequence: 123,
    createdBy: '<string>',
    createdOn: '2023-11-07T05:31:56Z',
    deleteUserEmail: '<string>',
    deleteUserId: '<string>',
    deleted: true,
    deletedDate: '2023-11-07T05:31:56Z',
    deprecated: true,
    description: '<string>',
    eventAware: true,
    extensionPackRef: '<string>',
    id: '<string>',
    metadata: {
      actions: '<unknown>',
      additionalTaxonOptions: '<unknown>',
      allowedHosts: ['<string>'],
      baseDir: '<string>',
      bridgeType: '<string>',
      contents: ['<string>'],
      eventAware: true,
      ignoredContents: ['<string>'],
      inferable: true,
      inferenceOptions: '<unknown>',
      messageTemplates: '<unknown>',
      moduleRuntimeParameters: {},
      moduleRuntimeRef: '<string>',
      moduleSidecars: ['<string>'],
      optionTabs: '<unknown>',
      script: '<string>',
      scriptLanguage: '<string>',
      state: '<string>',
      stateHash: '<string>',
      supportsScheduling: true,
      taxonFeatures: '<unknown>',
      taxonomy: '<unknown>',
      type: '<string>'
    },
    moduleStatus: '<string>',
    moduleType: '<string>',
    name: '<string>',
    organization: {
      changeSequence: 123,
      createdOn: '2023-11-07T05:31:56Z',
      id: '<string>',
      name: '<string>',
      slug: '<string>',
      updatedOn: '2023-11-07T05:31:56Z',
      uuid: '<string>'
    },
    organizationId: '<string>',
    publicAccess: true,
    slug: '<string>',
    supportsScheduling: true,
    template: true,
    type: '<string>',
    updatedOn: '2023-11-07T05:31:56Z',
    uuid: '<string>',
    yamlSource: '<string>'
  })
};

fetch('https://platform.kodexa.ai/api/orchestrator-modules', 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/orchestrator-modules",
  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([
    'changeSequence' => 123,
    'createdBy' => '<string>',
    'createdOn' => '2023-11-07T05:31:56Z',
    'deleteUserEmail' => '<string>',
    'deleteUserId' => '<string>',
    'deleted' => true,
    'deletedDate' => '2023-11-07T05:31:56Z',
    'deprecated' => true,
    'description' => '<string>',
    'eventAware' => true,
    'extensionPackRef' => '<string>',
    'id' => '<string>',
    'metadata' => [
        'actions' => '<unknown>',
        'additionalTaxonOptions' => '<unknown>',
        'allowedHosts' => [
                '<string>'
        ],
        'baseDir' => '<string>',
        'bridgeType' => '<string>',
        'contents' => [
                '<string>'
        ],
        'eventAware' => true,
        'ignoredContents' => [
                '<string>'
        ],
        'inferable' => true,
        'inferenceOptions' => '<unknown>',
        'messageTemplates' => '<unknown>',
        'moduleRuntimeParameters' => [
                
        ],
        'moduleRuntimeRef' => '<string>',
        'moduleSidecars' => [
                '<string>'
        ],
        'optionTabs' => '<unknown>',
        'script' => '<string>',
        'scriptLanguage' => '<string>',
        'state' => '<string>',
        'stateHash' => '<string>',
        'supportsScheduling' => true,
        'taxonFeatures' => '<unknown>',
        'taxonomy' => '<unknown>',
        'type' => '<string>'
    ],
    'moduleStatus' => '<string>',
    'moduleType' => '<string>',
    'name' => '<string>',
    'organization' => [
        'changeSequence' => 123,
        'createdOn' => '2023-11-07T05:31:56Z',
        'id' => '<string>',
        'name' => '<string>',
        'slug' => '<string>',
        'updatedOn' => '2023-11-07T05:31:56Z',
        'uuid' => '<string>'
    ],
    'organizationId' => '<string>',
    'publicAccess' => true,
    'slug' => '<string>',
    'supportsScheduling' => true,
    'template' => true,
    'type' => '<string>',
    'updatedOn' => '2023-11-07T05:31:56Z',
    'uuid' => '<string>',
    'yamlSource' => '<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/orchestrator-modules"

	payload := strings.NewReader("{\n  \"changeSequence\": 123,\n  \"createdBy\": \"<string>\",\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"description\": \"<string>\",\n  \"eventAware\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"actions\": \"<unknown>\",\n    \"additionalTaxonOptions\": \"<unknown>\",\n    \"allowedHosts\": [\n      \"<string>\"\n    ],\n    \"baseDir\": \"<string>\",\n    \"bridgeType\": \"<string>\",\n    \"contents\": [\n      \"<string>\"\n    ],\n    \"eventAware\": true,\n    \"ignoredContents\": [\n      \"<string>\"\n    ],\n    \"inferable\": true,\n    \"inferenceOptions\": \"<unknown>\",\n    \"messageTemplates\": \"<unknown>\",\n    \"moduleRuntimeParameters\": {},\n    \"moduleRuntimeRef\": \"<string>\",\n    \"moduleSidecars\": [\n      \"<string>\"\n    ],\n    \"optionTabs\": \"<unknown>\",\n    \"script\": \"<string>\",\n    \"scriptLanguage\": \"<string>\",\n    \"state\": \"<string>\",\n    \"stateHash\": \"<string>\",\n    \"supportsScheduling\": true,\n    \"taxonFeatures\": \"<unknown>\",\n    \"taxonomy\": \"<unknown>\",\n    \"type\": \"<string>\"\n  },\n  \"moduleStatus\": \"<string>\",\n  \"moduleType\": \"<string>\",\n  \"name\": \"<string>\",\n  \"organization\": {\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"supportsScheduling\": true,\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<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/orchestrator-modules")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"changeSequence\": 123,\n  \"createdBy\": \"<string>\",\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"description\": \"<string>\",\n  \"eventAware\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"actions\": \"<unknown>\",\n    \"additionalTaxonOptions\": \"<unknown>\",\n    \"allowedHosts\": [\n      \"<string>\"\n    ],\n    \"baseDir\": \"<string>\",\n    \"bridgeType\": \"<string>\",\n    \"contents\": [\n      \"<string>\"\n    ],\n    \"eventAware\": true,\n    \"ignoredContents\": [\n      \"<string>\"\n    ],\n    \"inferable\": true,\n    \"inferenceOptions\": \"<unknown>\",\n    \"messageTemplates\": \"<unknown>\",\n    \"moduleRuntimeParameters\": {},\n    \"moduleRuntimeRef\": \"<string>\",\n    \"moduleSidecars\": [\n      \"<string>\"\n    ],\n    \"optionTabs\": \"<unknown>\",\n    \"script\": \"<string>\",\n    \"scriptLanguage\": \"<string>\",\n    \"state\": \"<string>\",\n    \"stateHash\": \"<string>\",\n    \"supportsScheduling\": true,\n    \"taxonFeatures\": \"<unknown>\",\n    \"taxonomy\": \"<unknown>\",\n    \"type\": \"<string>\"\n  },\n  \"moduleStatus\": \"<string>\",\n  \"moduleType\": \"<string>\",\n  \"name\": \"<string>\",\n  \"organization\": {\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"supportsScheduling\": true,\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://platform.kodexa.ai/api/orchestrator-modules")

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  \"changeSequence\": 123,\n  \"createdBy\": \"<string>\",\n  \"createdOn\": \"2023-11-07T05:31:56Z\",\n  \"deleteUserEmail\": \"<string>\",\n  \"deleteUserId\": \"<string>\",\n  \"deleted\": true,\n  \"deletedDate\": \"2023-11-07T05:31:56Z\",\n  \"deprecated\": true,\n  \"description\": \"<string>\",\n  \"eventAware\": true,\n  \"extensionPackRef\": \"<string>\",\n  \"id\": \"<string>\",\n  \"metadata\": {\n    \"actions\": \"<unknown>\",\n    \"additionalTaxonOptions\": \"<unknown>\",\n    \"allowedHosts\": [\n      \"<string>\"\n    ],\n    \"baseDir\": \"<string>\",\n    \"bridgeType\": \"<string>\",\n    \"contents\": [\n      \"<string>\"\n    ],\n    \"eventAware\": true,\n    \"ignoredContents\": [\n      \"<string>\"\n    ],\n    \"inferable\": true,\n    \"inferenceOptions\": \"<unknown>\",\n    \"messageTemplates\": \"<unknown>\",\n    \"moduleRuntimeParameters\": {},\n    \"moduleRuntimeRef\": \"<string>\",\n    \"moduleSidecars\": [\n      \"<string>\"\n    ],\n    \"optionTabs\": \"<unknown>\",\n    \"script\": \"<string>\",\n    \"scriptLanguage\": \"<string>\",\n    \"state\": \"<string>\",\n    \"stateHash\": \"<string>\",\n    \"supportsScheduling\": true,\n    \"taxonFeatures\": \"<unknown>\",\n    \"taxonomy\": \"<unknown>\",\n    \"type\": \"<string>\"\n  },\n  \"moduleStatus\": \"<string>\",\n  \"moduleType\": \"<string>\",\n  \"name\": \"<string>\",\n  \"organization\": {\n    \"changeSequence\": 123,\n    \"createdOn\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"slug\": \"<string>\",\n    \"updatedOn\": \"2023-11-07T05:31:56Z\",\n    \"uuid\": \"<string>\"\n  },\n  \"organizationId\": \"<string>\",\n  \"publicAccess\": true,\n  \"slug\": \"<string>\",\n  \"supportsScheduling\": true,\n  \"template\": true,\n  \"type\": \"<string>\",\n  \"updatedOn\": \"2023-11-07T05:31:56Z\",\n  \"uuid\": \"<string>\",\n  \"yamlSource\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "actions": "<unknown>",
    "additionalTaxonOptions": "<unknown>",
    "allowedHosts": [
      "<string>"
    ],
    "baseDir": "<string>",
    "bridgeType": "<string>",
    "contents": [
      "<string>"
    ],
    "eventAware": true,
    "ignoredContents": [
      "<string>"
    ],
    "inferable": true,
    "inferenceOptions": "<unknown>",
    "messageTemplates": "<unknown>",
    "moduleRuntimeParameters": {},
    "moduleRuntimeRef": "<string>",
    "moduleSidecars": [
      "<string>"
    ],
    "optionTabs": "<unknown>",
    "script": "<string>",
    "scriptLanguage": "<string>",
    "state": "<string>",
    "stateHash": "<string>",
    "supportsScheduling": true,
    "taxonFeatures": "<unknown>",
    "taxonomy": "<unknown>",
    "type": "<string>"
  },
  "moduleStatus": "<string>",
  "moduleType": "<string>",
  "name": "<string>",
  "organization": {
    "changeSequence": 123,
    "createdOn": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "name": "<string>",
    "slug": "<string>",
    "updatedOn": "2023-11-07T05:31:56Z",
    "uuid": "<string>"
  },
  "organizationId": "<string>",
  "publicAccess": true,
  "slug": "<string>",
  "supportsScheduling": true,
  "template": true,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<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 orchestrator module is a processing component used within pipelines.

​
changeSequence
integer<int32>
​
createdBy
string | null
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
description
string | null
​
eventAware
boolean | null
​
extensionPackRef
string
​
id
string
​
metadata
object
​
moduleStatus
string
​
moduleType
string
​
name
string
​
organization
object | null
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
supportsScheduling
boolean | null
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null

Response

Created OrchestratorModule

An orchestrator module is a processing component used within pipelines.

​
changeSequence
integer<int32>
​
createdBy
string | null
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
description
string | null
​
eventAware
boolean | null
​
extensionPackRef
string
​
id
string
​
metadata
object
​
moduleStatus
string
​
moduleType
string
​
name
string
​
organization
object | null
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
supportsScheduling
boolean | null
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null