API Documentation

Setup Agentic Components

Register Agent

Register Agent

Register an AI Agent

post

/v1/agent/register

Authorizations

Body

cluster_namestringrequired

Name of the cluster in which to deploy AI Agent

agent_namestringrequired

Name of the AI Agent

imagestringrequired

Container image for the AI Agent

image_pull_secretstringrequired

Image pull secret for pulling the AI Agent image

task_server_namestringrequired

Name of the task server that the AI Agent will execute tasks on

checkpoint_db_namestringrequired

Name of the checkpoint db in which the AI Agent will save its data

replicasintegerrequired

Number of replicas of AI agent to be deployed

iam_role_arnany of

IAM role to be assigned to the AI Agent

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/agent/register' \
  --header 'Content-Type: application/json' \
  --data '{
    "cluster_name": "text",
    "agent_name": "text",
    "image": "text",
    "image_pull_secret": "text",
    "task_server_name": "text",
    "checkpoint_db_name": "text",
    "replicas": 1,
    "iam_role_arn": "text"
  }'

201

422

201

{
  "message": "text"
}

Successful Response

Deploy Agent

Deploy Agent

Deply an AI Agent

post

/v1/agent/{agent_name}/deploy

Authorizations

Path parameters

agent_namestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/agent/{agent_name}/deploy'

200

422

200

{
  "message": "text"
}

Successful Response

Update Agent

Update Agent

Update an AI agent

patch

/v1/agent/{agent_name}

Authorizations

Path parameters

agent_namestringrequired

Body

imageany of

Container image for the AI Agent

image_pull_secretany of

Image pull secret for pulling the AI Agent image

task_server_nameany of

Name of the task server that the AI Agent will execute tasks on

checkpoint_db_nameany of

Name of the checkpoint db in which the AI Agent will save its data

replicasany of

Number of replicas of AI agent to be deployed

iam_role_arnany of

IAM role to be assigned to the AI Agent

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PATCH \
  --url '/v1/agent/{agent_name}' \
  --header 'Content-Type: application/json' \
  --data '{
    "image": "text",
    "image_pull_secret": "text",
    "task_server_name": "text",
    "checkpoint_db_name": "text",
    "replicas": 1,
    "iam_role_arn": "text"
  }'

200

422

200

{
  "message": "text"
}

Successful Response

Delete Agent

Delete Agent

Delete an AI Agent

delete

/v1/agent/{agent_name}

Authorizations

Path parameters

agent_namestringrequired

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/agent/{agent_name}'

200

422

200

{
  "message": "text"
}

Successful Response