Agent SwarmAgent Swarm

Schedules

Create and manage scheduled tasks — run agents on cron expressions or one-time delays

GET
/api/schedules

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

enabled?string
Value in"true" | "false"
name?string
scheduleType?string
Value in"recurring" | "one_time"
hideCompleted?string
Value in"true" | "false"
fields?string
Value in"full" | "slim"

Response Body

curl -X GET "http://localhost:3013/api/schedules"
Empty
POST
/api/schedules

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "http://localhost:3013/api/schedules" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "taskTemplate": "string"  }'
Empty
Empty
Empty
DELETE
/api/schedules/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X DELETE "http://localhost:3013/api/schedules/string"
Empty
Empty
GET
/api/schedules/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X GET "http://localhost:3013/api/schedules/string"
Empty
Empty
PUT
/api/schedules/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "http://localhost:3013/api/schedules/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
Empty
Empty
Empty
POST
/api/schedules/{id}/run

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Response Body

curl -X POST "http://localhost:3013/api/schedules/string/run"
Empty
Empty
Empty