Skip to main content
POST
/
api
/
module-runtimes
Create OrchestratorModuleRuntime
curl --request POST \
  --url https://platform.kodexa.ai/api/module-runtimes \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "changeSequence": 123,
  "configMapName": "<string>",
  "configMapResourceVersion": "<string>",
  "cpuMillicores": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "dockerImageUri": "<string>",
  "environmentVars": {},
  "ephemeralStorageMb": 123,
  "errorMessage": "<string>",
  "executionType": "<string>",
  "extensionPackRef": "<string>",
  "id": "<string>",
  "lambdaArn": "<string>",
  "lambdaFunctionName": "<string>",
  "memoryMb": 123,
  "metadata": {
    "containerUrl": "<string>",
    "deploymentDefaults": "<unknown>",
    "deploymentType": "<string>",
    "eventAction": "<string>",
    "inferenceAction": "<string>",
    "trainingAction": "<string>",
    "type": "<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>",
  "provisionedAt": "2023-11-07T05:31:56Z",
  "publicAccess": true,
  "resultQueueUrl": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "template": true,
  "timeoutSeconds": 123,
  "type": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "uuid": "<string>",
  "yamlSource": "<string>"
}
'
{
  "changeSequence": 123,
  "configMapName": "<string>",
  "configMapResourceVersion": "<string>",
  "cpuMillicores": 123,
  "createdOn": "2023-11-07T05:31:56Z",
  "deleteUserEmail": "<string>",
  "deleteUserId": "<string>",
  "deleted": true,
  "deletedDate": "2023-11-07T05:31:56Z",
  "deprecated": true,
  "description": "<string>",
  "dockerImageUri": "<string>",
  "environmentVars": {},
  "ephemeralStorageMb": 123,
  "errorMessage": "<string>",
  "executionType": "<string>",
  "extensionPackRef": "<string>",
  "id": "<string>",
  "lambdaArn": "<string>",
  "lambdaFunctionName": "<string>",
  "memoryMb": 123,
  "metadata": {
    "containerUrl": "<string>",
    "deploymentDefaults": "<unknown>",
    "deploymentType": "<string>",
    "eventAction": "<string>",
    "inferenceAction": "<string>",
    "trainingAction": "<string>",
    "type": "<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>",
  "provisionedAt": "2023-11-07T05:31:56Z",
  "publicAccess": true,
  "resultQueueUrl": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "template": true,
  "timeoutSeconds": 123,
  "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 runtime defines a processing environment for orchestrator modules.

​
changeSequence
integer<int32>
​
configMapName
string | null
​
configMapResourceVersion
string | null
​
cpuMillicores
integer<int32>
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
description
string | null
​
dockerImageUri
string
​
environmentVars
object
​
ephemeralStorageMb
integer<int32>
​
errorMessage
string | null
​
executionType
string
​
extensionPackRef
string
​
id
string
​
lambdaArn
string | null
​
lambdaFunctionName
string | null
​
memoryMb
integer<int32>
​
metadata
object
​
name
string
​
organization
object
​
organizationId
string
​
provisionedAt
string<date-time> | null
​
publicAccess
boolean
​
resultQueueUrl
string | null
​
slug
string
​
status
string
​
template
boolean
​
timeoutSeconds
integer<int32>
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null

Response

Created OrchestratorModuleRuntime

An orchestrator module runtime defines a processing environment for orchestrator modules.

​
changeSequence
integer<int32>
​
configMapName
string | null
​
configMapResourceVersion
string | null
​
cpuMillicores
integer<int32>
​
createdOn
string<date-time>
​
deleteUserEmail
string | null
​
deleteUserId
string | null
​
deleted
boolean
​
deletedDate
string<date-time> | null
​
deprecated
boolean
​
description
string | null
​
dockerImageUri
string
​
environmentVars
object
​
ephemeralStorageMb
integer<int32>
​
errorMessage
string | null
​
executionType
string
​
extensionPackRef
string
​
id
string
​
lambdaArn
string | null
​
lambdaFunctionName
string | null
​
memoryMb
integer<int32>
​
metadata
object
​
name
string
​
organization
object
​
organizationId
string
​
provisionedAt
string<date-time> | null
​
publicAccess
boolean
​
resultQueueUrl
string | null
​
slug
string
​
status
string
​
template
boolean
​
timeoutSeconds
integer<int32>
​
type
string
​
updatedOn
string<date-time>
​
uuid
string
​
yamlSource
string | null