Tasks
Tasks API endpoints
Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Response Body
curl -X GET "http://localhost:3013/api/paused-tasks"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Query Parameters
"true" | "false"Response Body
curl -X GET "http://localhost:3013/api/tasks"Authorization
bearerAuth 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" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
Response Body
curl -X GET "http://localhost:3013/api/tasks/string"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
Response Body
curl -X POST "http://localhost:3013/api/tasks/string/cancel"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
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" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
Query Parameters
1001 <= value <= 500Response Body
curl -X GET "http://localhost:3013/api/tasks/string/context"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
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" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
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" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
Response Body
curl -X POST "http://localhost:3013/api/tasks/string/pause"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
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" }'Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
Response Body
curl -X POST "http://localhost:3013/api/tasks/string/resume"Authorization
bearerAuth API key via Authorization: Bearer <API_KEY>
In: header
Path Parameters
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" }'