Skip to main content
GET
/
api
/
orchestrator-modules
/
{id}
Get OrchestratorModule by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/orchestrator-modules/{id} \
  --header 'x-api-key: <api-key>'
{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "entryPoint": "<string>",
  "eventAware": true,
  "extensionPackRef": "<string>",
  "id": "<string>",
  "metadata": {
    "additionalTaxonOptions": {},
    "baseDir": "<string>",
    "contents": [
      "<string>"
    ],
    "eventAware": true,
    "ignoredContents": [
      "<string>"
    ],
    "inferable": true,
    "inferenceOptions": {},
    "messageTemplates": {},
    "modelRuntimeParameters": {},
    "modelRuntimeRef": "<string>",
    "modelSidecars": [
      "<string>"
    ],
    "optionTabs": {},
    "script": "<string>",
    "scriptLanguage": "<string>",
    "state": "<string>",
    "stateHash": "<string>",
    "supportsScheduling": true,
    "taxonFeatures": {},
    "taxonomy": {},
    "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,
  "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.

Path Parameters

id
string<uuid>
required

Unique identifier (UUID) of the resource.

Response

The 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
entryPoint
string
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
updatedOn
string<date-time>
uuid
string