Agent

Setup Agentic Components

Register Agent

Register Agent

post

Register an AI Agent

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 ofOptional

IAM role to be assigned to the AI Agent

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/agent/register HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "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"
}

{
  "message": "text"
}

Deploy Agent

Deploy Agent

post

Deply an AI Agent

Authorizations

Path parameters

agent_namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

HTTPcURLJavaScriptPython

POST /v1/agent/{agent_name}/deploy HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "text"
}

Update Agent

Update Agent

patch

Update an AI agent

Authorizations

Path parameters

agent_namestringRequired

Body

imageany ofOptional

Container image for the AI Agent

stringOptional

or

nullOptional

image_pull_secretany ofOptional

Image pull secret for pulling the AI Agent image

stringOptional

or

nullOptional

task_server_nameany ofOptional

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

stringOptional

or

nullOptional

checkpoint_db_nameany ofOptional

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

stringOptional

or

nullOptional

replicasany ofOptional

Number of replicas of AI agent to be deployed

integerOptional

or

nullOptional

iam_role_arnany ofOptional

IAM role to be assigned to the AI Agent

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

patch

HTTPcURLJavaScriptPython

PATCH /v1/agent/{agent_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "image": "text",
  "image_pull_secret": "text",
  "task_server_name": "text",
  "checkpoint_db_name": "text",
  "replicas": 1,
  "iam_role_arn": "text"
}

{
  "message": "text"
}

Delete Agent

Delete Agent

delete

Delete an AI Agent

Authorizations

Path parameters

agent_namestringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/agent/{agent_name} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "message": "text"
}