Manage Agents

List Agents

GET /api/v1/managed-agents/agents

Returns every agent in your workspace.

Agent[]

Show Agent object

string

string | null

string

Always "agent"

boolean

string

"active" or "draft"

string

ISO 8601 timestamp

string

ISO 8601 timestamp

curl https://suite.sundaypyjamas.com/api/v1/managed-agents/agents \
  -H "Authorization: Bearer spj_ai_your_api_key_here"

{
  "agents": [
    {
      "id": "3fae1c2e-...",
      "name": "Research Assistant",
      "description": "Summarizes market research documents",
      "businessUseCase": "Managed agent",
      "appType": "agent",
      "isPublic": false,
      "status": "active",
      "createdAt": "2026-06-01T12:00:00Z",
      "updatedAt": "2026-06-14T09:30:00Z"
    }
  ]
}

Create Agent

POST /api/v1/managed-agents/agents

string

required

Display name for the agent.

string

default:"Managed agent"

Free-text description of what this agent is for.

string

Longer description shown in agent listings.

string

System prompt that defines the agent’s behavior and persona.

object

Partial agent config object. Deep-merged with platform defaults — you only need to specify the fields you want to override.

object

Show llm

string

ID of the LLM component/model to bind to this agent.

curl -X POST https://suite.sundaypyjamas.com/api/v1/managed-agents/agents \
  -H "Authorization: Bearer spj_ai_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Research Assistant",
    "description": "Summarizes market research documents",
    "prompt": "You are a meticulous research analyst.",
    "config": {
      "capabilities": {
        "tools": { "web_search": true }
      }
    }
  }'

{
  "agent": {
    "id": "3fae1c2e-...",
    "name": "Research Assistant",
    "appType": "agent",
    "createdAt": "2026-07-08T10:00:00Z"
  }
}

Returns 400 with "name is required" if name is missing or empty.

Get Agent

GET /api/v1/managed-agents/agents/&#123;agentId&#125;

object

Show Agent detail

string

string | null

string

"assist" or "autonomous"

string

object

See Agent Config Reference

curl https://suite.sundaypyjamas.com/api/v1/managed-agents/agents/3fae1c2e-... \
  -H "Authorization: Bearer spj_ai_your_api_key_here"

{ "error": "Agent not found" }

Update Agent

PATCH /api/v1/managed-agents/agents/&#123;agentId&#125;

All fields are optional — only the fields you send are changed.

string

boolean

object

Partial config, deep-merged with the agent’s existing config.

AgentToolBinding[]

Replaces the agent’s full tool binding list.

object[]

Show integration binding

string

required

string

required

string[]

boolean

curl -X PATCH https://suite.sundaypyjamas.com/api/v1/managed-agents/agents/3fae1c2e-... \
  -H "Authorization: Bearer spj_ai_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "config": { "capabilities": { "tools": { "web_fetch": true } } } }'

Delete Agent

DELETE /api/v1/managed-agents/agents/&#123;agentId&#125;

{ "deleted": true }

Agent Config Reference

The config object controls runtime behavior. All fields are optional and merge with DEFAULT_MANAGED_AGENT_CONFIG.

Field	Type	Description
`platformVersion`	number	Config schema version (currently `2`)
`kind`	string	Always `"agent"`
`runtimeMode`	`"assist"` \| `"autonomous"`	How the agent is driven
`capabilities.memory.enabled`	boolean	Whether the agent retains memory across turns
`capabilities.memory.scope`	`"agent"` \| `"workspace"`	Memory isolation scope
`capabilities.deliverables.enabled`	boolean	Required `true` to use the Runs API
`capabilities.tools.web_search`	boolean	Enable web search tool
`capabilities.tools.web_fetch`	boolean	Enable URL fetching tool
`capabilities.tools.web_provider`	`"perplexity"` \| `"tavily"` \| `"both"`	Search provider
`capabilities.mcp_servers`	array	Connected MCP servers
`compute.maxIterations`	number	Max reasoning/tool-call loops per run
`compute.maxWallClockMs`	number	Hard timeout per run
`toolAllowlist`	string[]	Restricts which tools the agent may call
`customTools`	object[]	Custom tool definitions with `name`, `description`, `inputSchema`, `callbackUrl`

Chat

Agents

RAG

Artifacts

Image

Vector Store

Apps

Storage

Integrations

Insights

Platform Tools

List Agents

Create Agent

Get Agent

Update Agent

Delete Agent

Agent Config Reference

​List Agents

​Create Agent

​Get Agent

​Update Agent

​Delete Agent

​Agent Config Reference

List Agents

Create Agent

Get Agent

Update Agent

Delete Agent

Agent Config Reference