Skip to main content
PUT
Update OrchestratorAgent

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.

Body

application/json

An agent is an instantiated agent runtime within an org+project, tracking lifecycle and configuration.

agentRuntimeId
string
agentRuntimeRef
string | null
changeSequence
integer<int32>
createdBy
string | null
createdOn
string<date-time>
description
string | null
id
string
metadata
any
moduleRefs
string[]
name
string
organizationId
string
projectId
string
slug
string
status
string
taskId
string | null
updatedOn
string<date-time>
userId
string | null
uuid
string

Response

Updated OrchestratorAgent

An agent is an instantiated agent runtime within an org+project, tracking lifecycle and configuration.

agentRuntimeId
string
agentRuntimeRef
string | null
changeSequence
integer<int32>
createdBy
string | null
createdOn
string<date-time>
description
string | null
id
string
metadata
any
moduleRefs
string[]
name
string
organizationId
string
projectId
string
slug
string
status
string
taskId
string | null
updatedOn
string<date-time>
userId
string | null
uuid
string