Agent SwarmAgent Swarm

Tasks

Tasks API endpoints

GET
/api/paused-tasks

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Response Body

curl -X GET "http://localhost:3013/api/paused-tasks"
Empty
GET
/api/tasks

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Query Parameters

status?string
agentId?string
scheduleId?string
search?string
includeHeartbeat?string
Value in"true" | "false"
limit?|
offset?|

Response Body

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

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/tasks" \  -H "Content-Type: application/json" \  -d '{    "task": "string"  }'
Empty
Empty
GET
/api/tasks/{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/tasks/string"
Empty
Empty
POST
/api/tasks/{id}/cancel

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/tasks/string/cancel"
Empty
Empty
Empty
PUT
/api/tasks/{id}/claude-session

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/tasks/string/claude-session" \  -H "Content-Type: application/json" \  -d '{    "claudeSessionId": "string"  }'
Empty
Empty
GET
/api/tasks/{id}/context

Authorization

bearerAuth
AuthorizationBearer <token>

API key via Authorization: Bearer <API_KEY>

In: header

Path Parameters

id*string

Query Parameters

limit?integer
Default100
Range1 <= value <= 500

Response Body

curl -X GET "http://localhost:3013/api/tasks/string/context"
Empty
Empty
POST
/api/tasks/{id}/context

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 POST "http://localhost:3013/api/tasks/string/context" \  -H "Content-Type: application/json" \  -d '{    "eventType": "progress",    "sessionId": "string"  }'
Empty
Empty
Empty
POST
/api/tasks/{id}/finish

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 POST "http://localhost:3013/api/tasks/string/finish" \  -H "Content-Type: application/json" \  -d '{    "status": "completed"  }'
Empty
Empty
Empty
Empty
POST
/api/tasks/{id}/pause

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/tasks/string/pause"
Empty
Empty
Empty
Empty
POST
/api/tasks/{id}/progress

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 POST "http://localhost:3013/api/tasks/string/progress" \  -H "Content-Type: application/json" \  -d '{    "progress": "string"  }'
Empty
Empty
POST
/api/tasks/{id}/resume

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/tasks/string/resume"
Empty
Empty
Empty
Empty
PATCH
/api/tasks/{id}/vcs

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 PATCH "http://localhost:3013/api/tasks/string/vcs" \  -H "Content-Type: application/json" \  -d '{    "vcsProvider": "github",    "vcsRepo": "string",    "vcsNumber": 0,    "vcsUrl": "http://example.com"  }'
Empty
Empty