Skip to main content
GET
/
api
/
agents
/
{id}
Get OrchestratorAgent by ID
curl --request GET \
  --url https://platform.kodexa.ai/api/agents/{id} \
  --header 'x-api-key: <api-key>'
{
  "agentRuntimeId": "<string>",
  "agentRuntimeRef": "<string>",
  "changeSequence": 123,
  "createdBy": "<string>",
  "createdOn": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "id": "<string>",
  "metadata": {},
  "moduleRefs": [
    "<string>"
  ],
  "name": "<string>",
  "organizationId": "<string>",
  "projectId": "<string>",
  "slug": "<string>",
  "status": "<string>",
  "taskId": "<string>",
  "updatedOn": "2023-11-07T05:31:56Z",
  "userId": "<string>",
  "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 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
object
​
moduleRefs
string[]
​
name
string
​
organizationId
string
​
projectId
string
​
slug
string
​
status
string
​
taskId
string | null
​
updatedOn
string<date-time>
​
userId
string | null
​
uuid
string