Skip to main content
Agents process requests with JSON payloads and optional file uploads. You can run them through the UI or CLI.

​
Running via UI

Navigate to Agents in the AgentSystems UI at http://localhost:3001.
1

Select Agent

Browse available agents and click Turn On on your chosen agent (agents auto-start if invoked while off)
2

Configure Request

  • Enter JSON payload in the request editor
  • Upload input files if needed
  • Review agent requirements
3

Execute

Click Execute to start execution
4

Monitor Progress

Watch real-time progress updates and logs
5

Access Results

Download output files when complete

​
Running via CLI

Use the SDK CLI to run agents programmatically. See CLI Commands for details.

​
Request Structure

Every agent request includes:
JSON object with agent-specific parameters:
{
  "action": "analyze",
  "format": "csv",
  "options": {
    "verbose": true
  }
}
Upload files for processing:
  • Via UI: Drag & drop or browse
  • Via CLI: Use --input-file flag
  • Multiple files supported
  • All common formats accepted
Unique identifier for the execution:
  • Auto-generated if not provided
  • Used to track progress
  • Required for accessing artifacts

​
Response Handling

Agents return structured responses: 
{
  "thread_id": "abc123-def456",
  "status": "completed",
  "progress": 100,
  "messages": [
    {
      "type": "result",
      "content": "Analysis complete"
    }
  ],
  "artifacts": [
    "output/results.csv",
    "output/report.pdf"
  ]
}

​
Status Values

StatusDescription
pendingRequest queued
in_progressAgent processing
completedSuccess
failedError occurred

​
Accessing Output Files

After execution, download output files through the UI execution details page.

​
Progress Tracking

Agents provide real-time progress updates in the UI.

​
Error Handling

When agents fail, error details appear in the UI execution log.
⌘I