Skip to main content

​
List Agents

List all agents for an instance with pagination, filtering, and sorting. Endpoint: GET /instances/:instanceId/agents Query Parameters:
  • type (string, optional) - Filter by type: “AI” or “HUMAN”
  • active (boolean, optional) - Filter by active status
  • name (string, optional) - Search by name
  • page (number, optional) - Page number (0-based)
  • size (number, optional) - Page size
  • sort (string, optional) - Sort field and direction (e.g., “name,desc”)
Response: Paginated response with agent list Source: Feature Inventory - API Surface (Agents API)

​
Get Agent

Get a single agent by ID. Endpoint: GET /instances/:instanceId/agents/:agentId Response: Agent object Source: Feature Inventory - API Surface (Agents API)

​
Create Agent

Create a new agent. Endpoint: POST /instances/:instanceId/agents Request Body: 
{
  "name": "Agent Name",
  "type": "AI",
  "active": true,
  "capabilities": ["text_generation", "code_generation"],
  "model": "gpt-4",
  "priority": "high",
  "metadata": {}
}
Fields:
  • name (string, required) - Agent name
  • type (string, required) - Agent type: “AI” or “HUMAN”
  • active (boolean, required) - Whether agent is active
  • capabilities (array, optional) - Agent capabilities
  • model (string, optional, AI only) - AI model identifier
  • priority (string, optional) - Priority level: “high”, “medium”, “low”
  • metadata (object, optional) - Additional metadata
Response: Created agent object Source: Feature Inventory - API Surface (Agents API)

​
Update Agent

Update an existing agent. Endpoint: PUT /instances/:instanceId/agents/:agentId Request Body: Same as Create Agent Response: Updated agent object Source: Feature Inventory - API Surface (Agents API)

​
Delete Agent

Delete an agent. Endpoint: DELETE /instances/:instanceId/agents/:agentId Response: 204 No Content Source: Feature Inventory - API Surface (Agents API)