Tasks

About 526 wordsAbout 2 min

Generated from docs/.vuepress/openapi.json. Refresh with npm run gen:api. Back to overview.

`GET /api/v1/tasks` — Index Task

Tags: Tasks

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/tasks` — Store Task

Tags: Tasks

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`GET /api/v1/tasks/{taskId}` — Show Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/tasks/{taskId}` — Destroy Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/tasks/{taskId}/abort` — Abort Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes
`taskId`	string	yes

Responses

Status	Description
`200`	JSON envelope: `{data: {task: ...}}` with status `ABORTED`.
`404`	NOT_FOUND — task is not owned by the calling user.
`409`	INVALID_STATE — task is terminal or already-paused.

`POST /api/v1/tasks/{taskId}/abort-sub-agent` — Abort sub-agent and cascade-up

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes
`taskId`	string	yes

Responses

Status	Description
`200`	JSON envelope: `{data: {task: ...}}` with status `ABORTED`.
`404`	NOT_FOUND — task is not owned by the calling user.
`409`	INVALID_STATE — task is terminal or already-paused.

`POST /api/v1/tasks/{taskId}/answer` — Answer pending question batch

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes
`taskId`	string	yes

Responses

Status	Description
`200`	JSON envelope: `{data: {task: ...}}` — status flips to `QUEUED` (or stays `AWAITING_INPUT` if more batches are still pending).
`404`	NOT_FOUND — task is not owned by the calling user.
`422`	VALIDATION_ERROR — malformed body or unknown header/selection.

`POST /api/v1/tasks/{taskId}/approve` — Approve Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/tasks/{taskId}/continue` — Continue Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/tasks/{taskId}/reject` — Reject Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/tasks/{taskId}/retry` — Retry Task

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`DELETE /api/v1/tasks/{taskId}/retry-chain` — CancelRetryChain RetryChain

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes

Responses

Status	Description
`default`	JSON envelope: `{data: ...}` on success, `{error: {code, message}}` on error.

`POST /api/v1/tasks/{taskId}/tick` — Tick a task (client-worker mode only)

Tags: Tasks

Path parameters

Name	Type	Required	Description
`taskId`	string	yes
`taskId`	string	yes

Responses

Status	Description
`200`	JSON envelope: `{data: {task: ...}}` with the post-tick task resource.
`404`	NOT_FOUND — server mode is active or task is not owned by the calling user.
`409`	INVALID_STATE — task is terminal, quiescent, or being ticked by another caller.
`429`	TOO_MANY_REQUESTS — per-user rate limit exceeded.