Tasks
For instructions on how to authenticate to use this endpoint, see API overview.
Endpoints
GET | |
POST | |
GET | |
PATCH | |
DELETE | |
POST | |
POST | |
POST | |
GET | |
POST |
List all tasks
Get a list of tasks for the current project, with optional filtering by origin product, stage, organization, repository, and created_by.
Required API key scopes
task:readQuery parameters
- created_byinteger
- internalboolean
- limitinteger
- offsetinteger
- organizationstring
- origin_productstring
- repositorystring
- searchstring
- stagestring
- statusstringOne of:
"not_started""queued""in_progress""completed""failed""cancelled"
Response
Example request
GET /api /projects /:project_id /tasksExample response
Status 200 List of tasks
List all tasks
Get a list of tasks for the current project, with optional filtering by origin product, stage, organization, repository, and created_by.
Required API key scopes
task:readQuery parameters
- created_byinteger
- internalboolean
- limitinteger
- offsetinteger
- organizationstring
- origin_productstring
- repositorystring
- searchstring
- stagestring
- statusstringOne of:
"not_started""queued""in_progress""completed""failed""cancelled"
Response
Example request
GET /api /projects /:project_id /tasksExample response
Status 200 List of tasks
Create tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:writeRequest parameters
- titlestring
- title_manually_setboolean
- descriptionstring
- origin_product
- repositorystringnull
- github_integrationintegernull
- github_user_integrationstringnull
- signal_reportstringnull
- signal_report_task_relationship
- json_schema
- internalboolean
- ci_promptstringnull
Response
Example request
POST /api /projects /:project_id /tasksExample response
Status 201
Create tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:writeRequest parameters
- titlestring
- title_manually_setboolean
- descriptionstring
- origin_product
- repositorystringnull
- github_integrationintegernull
- github_user_integrationstringnull
- signal_reportstringnull
- signal_report_task_relationship
- json_schema
- internalboolean
- ci_promptstringnull
Response
Example request
POST /api /projects /:project_id /tasksExample response
Status 201
Retrieve tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /tasks /:idExample response
Status 200
Retrieve tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:readPath parameters
- idstring
Response
Example request
GET /api /projects /:project_id /tasks /:idExample response
Status 200
Update tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:writePath parameters
- idstring
Request parameters
- titlestring
- title_manually_setboolean
- descriptionstring
- origin_product
- repositorystringnull
- github_integrationintegernull
- github_user_integrationstringnull
- signal_reportstringnull
- signal_report_task_relationship
- json_schema
- internalboolean
- ci_promptstringnull
Response
Example request
PATCH /api /projects /:project_id /tasks /:idExample response
Status 200
Update tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:writePath parameters
- idstring
Request parameters
- titlestring
- title_manually_setboolean
- descriptionstring
- origin_product
- repositorystringnull
- github_integrationintegernull
- github_user_integrationstringnull
- signal_reportstringnull
- signal_report_task_relationship
- json_schema
- internalboolean
- ci_promptstringnull
Response
Example request
PATCH /api /projects /:project_id /tasks /:idExample response
Status 200
Delete tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:writePath parameters
- idstring
Example request
DELETE /api /projects /:project_id /tasks /:idExample response
Status 204 No response body
Delete tasks
API for managing tasks within a project. Tasks represent units of work to be performed by an agent.
Required API key scopes
task:writePath parameters
- idstring
Example request
DELETE /api /projects /:project_id /tasks /:idExample response
Status 204 No response body
Create tasks run
Create a new task run and kick off the workflow.
Required API key scopes
task:writePath parameters
- idstring
Response
Example request
Example response
Status 200 Task with updated latest run
Status 400 Invalid task run payload
Status 404 Task not found
Create tasks run
Create a new task run and kick off the workflow.
Required API key scopes
task:writePath parameters
- idstring
Response
Example request
Example response
Status 200 Task with updated latest run
Status 400 Invalid task run payload
Status 404 Task not found
Create tasks staged artifacts finalize upload
Verify staged S3 uploads and cache their metadata so they can be attached to the next run created for this task.
Required API key scopes
task:writePath parameters
- idstring
Request parameters
- artifactsarray
Response
Example request
POST /api /projects /:project_id /tasks /:id /staged_artifacts /finalize_uploadExample response
Status 200 Finalized staged artifacts available for the next task run
Status 400 Invalid artifact payload
Status 404 Task not found
Create tasks staged artifacts finalize upload
Verify staged S3 uploads and cache their metadata so they can be attached to the next run created for this task.
Required API key scopes
task:writePath parameters
- idstring
Request parameters
- artifactsarray
Response
Example request
POST /api /projects /:project_id /tasks /:id /staged_artifacts /finalize_uploadExample response
Status 200 Finalized staged artifacts available for the next task run
Status 400 Invalid artifact payload
Status 404 Task not found
Create tasks staged artifacts prepare upload
Reserve S3 object keys for task attachments before creating a new run and return presigned POST forms for direct uploads.
Required API key scopes
task:writePath parameters
- idstring
Request parameters
- artifactsarray
Response
Example request
POST /api /projects /:project_id /tasks /:id /staged_artifacts /prepare_uploadExample response
Status 200 Prepared staged uploads for the requested artifacts
Status 400 Invalid artifact payload
Status 404 Task not found
Create tasks staged artifacts prepare upload
Reserve S3 object keys for task attachments before creating a new run and return presigned POST forms for direct uploads.
Required API key scopes
task:writePath parameters
- idstring
Request parameters
- artifactsarray
Response
Example request
POST /api /projects /:project_id /tasks /:id /staged_artifacts /prepare_uploadExample response
Status 200 Prepared staged uploads for the requested artifacts
Status 400 Invalid artifact payload
Status 404 Task not found
List all tasks runs
Get a list of runs for a specific task.
Required API key scopes
task:readPath parameters
- task_idstring
Query parameters
- limitinteger
- offsetinteger
Response
Example request
GET /api /projects /:project_id /tasks /:task_id /runsExample response
Status 200 List of task runs
Create tasks runs
Create a new run for a specific task without starting execution.
Required API key scopes
task:writePath parameters
- task_idstring
Request parameters
- environmentDefault:
local - modeDefault:
background - branchstringnull
- sandbox_environment_idstring
- pr_authorship_mode
- run_source
- signal_report_idstring
- runtime_adapter
- modelstring
- reasoning_effort
- github_user_tokenstring
- initial_permission_mode
Response
Example request
POST /api /projects /:project_id /tasks /:task_id /runs