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",
  "description": "<string>",
  "entryPoint": "<string>",
  "id": "<string>",
  "inputSchema": {},
  "metadata": {},
  "moduleRuntimeId": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "outputSchema": {},
  "status": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>"
}
'
{
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "entryPoint": "<string>",
  "id": "<string>",
  "inputSchema": {},
  "metadata": {},
  "moduleRuntimeId": "<string>",
  "name": "<string>",
  "organizationId": "<string>",
  "outputSchema": {},
  "status": "<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 orchestrator module is a processing component used within pipelines.

changeSequence
integer<int32>
createdBy
string | null
createdOn
string<date-time>
description
string | null
entryPoint
string
id
string
inputSchema
object
metadata
object
moduleRuntimeId
string
name
string
organizationId
string
outputSchema
object
status
string
updatedOn
string<date-time>
uuid
string

Response

Created OrchestratorModule

An orchestrator module is a processing component used within pipelines.

changeSequence
integer<int32>
createdBy
string | null
createdOn
string<date-time>
description
string | null
entryPoint
string
id
string
inputSchema
object
metadata
object
moduleRuntimeId
string
name
string
organizationId
string
outputSchema
object
status
string
updatedOn
string<date-time>
uuid
string