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",
  "deprecated": true,
  "description": "<string>",
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "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>"
}
'
{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "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>"
}

Documentation Index

Fetch the complete documentation index at: https://developer.kodexa.ai/llms.txt

Use this file to discover all available pages before exploring further.

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>
​
deprecated
boolean
​
description
string | null
​
eventAware
boolean | null
​
extensionPackRef
string
​
id
string
​
metadata
object
​
moduleStatus
string
​
moduleType
string
​
name
string
​
organization
object
​
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>
​
deprecated
boolean
​
description
string | null
​
eventAware
boolean | null
​
extensionPackRef
string
​
id
string
​
metadata
object
​
moduleStatus
string
​
moduleType
string
​
name
string
​
organization
object
​
organizationId
string
​
publicAccess
boolean
​
slug
string
​
supportsScheduling
boolean | null
​
template
boolean
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null