shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-03 04:58:23 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
82f525baf36a2341bc92c2f6b6a27cc565d28a08
coder/docs/reference/api/experimental.md
T
Danielle Maywood 82f525baf3 feat(coderd): add task prompt modification endpoint (#20811) 
This PR adds the backend implementation for modifying task prompts. Part
of https://github.com/coder/internal/issues/1084

## Changes

- New `UpdateTaskPrompt` database query to update task prompts
- New PATCH `/api/v2/tasks/{task}/prompt` endpoint

## Notes

This is part 1 of a 2-part PR stack. The frontend UI will be added in a
follow-up PR based on this branch
(https://github.com/coder/coder/pull/20812).

---

🤖 PR was written by Claude Sonnet 4.5 Thinking using [Coder
Mux](https://github.com/coder/cmux) and reviewed by a human 👩
2025-11-25 11:13:32 +00:00

9.5 KiB
Generated
Raw Blame History

Experimental

List AI tasks

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/api/experimental/tasks \
  -H 'Accept: */*' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/experimental/tasks

Parameters

Name In Type Required Description
q query string false Search query for filtering tasks. Supports: owner:<username/uuid/me>, organization:<org-name/uuid>, status:

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK codersdk.TasksListResponse

To perform this operation, you must be authenticated. Learn more.

Create a new AI task

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/api/experimental/tasks/{user} \
  -H 'Content-Type: application/json' \
  -H 'Accept: */*' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/experimental/tasks/{user}

Body parameter

{
  "input": "string",
  "name": "string",
  "template_version_id": "0ba39c92-1f1b-4c32-aa3e-9925d7713eb1",
  "template_version_preset_id": "512a53a7-30da-446e-a1fc-713c630baff1"
}

Parameters

Name In Type Required Description
user path string true Username, user ID, or 'me' for the authenticated user
body body codersdk.CreateTaskRequest true Create task request

Example responses

201 Response

Responses

Status Meaning Description Schema
201 Created Created codersdk.Task

To perform this operation, you must be authenticated. Learn more.

Get AI task by ID

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/api/experimental/tasks/{user}/{task} \
  -H 'Accept: */*' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/experimental/tasks/{user}/{task}

Parameters

Name In Type Required Description
user path string true Username, user ID, or 'me' for the authenticated user
task path string true Task ID, or task name

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK codersdk.Task

To perform this operation, you must be authenticated. Learn more.

Delete AI task by ID

Code samples

# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/api/experimental/tasks/{user}/{task} \
  -H 'Coder-Session-Token: API_KEY'

DELETE /api/experimental/tasks/{user}/{task}

Parameters

Name In Type Required Description
user path string true Username, user ID, or 'me' for the authenticated user
task path string true Task ID, or task name

Responses

Status Meaning Description Schema
202 Accepted Task deletion initiated

To perform this operation, you must be authenticated. Learn more.

Update AI task input

Code samples

# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/api/experimental/tasks/{user}/{task}/input \
  -H 'Content-Type: application/json' \
  -H 'Coder-Session-Token: API_KEY'

PATCH /api/experimental/tasks/{user}/{task}/input

Body parameter

{
  "input": "string"
}

Parameters

Name In Type Required Description
user path string true Username, user ID, or 'me' for the authenticated user
task path string true Task ID, or task name
body body codersdk.UpdateTaskInputRequest true Update task input request

Responses

Status Meaning Description Schema
204 No Content No Content

To perform this operation, you must be authenticated. Learn more.

Get AI task logs

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/api/experimental/tasks/{user}/{task}/logs \
  -H 'Accept: */*' \
  -H 'Coder-Session-Token: API_KEY'

GET /api/experimental/tasks/{user}/{task}/logs

Parameters

Name In Type Required Description
user path string true Username, user ID, or 'me' for the authenticated user
task path string true Task ID, or task name

Example responses

200 Response

Responses

Status Meaning Description Schema
200 OK OK codersdk.TaskLogsResponse

To perform this operation, you must be authenticated. Learn more.

Send input to AI task

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/api/experimental/tasks/{user}/{task}/send \
  -H 'Content-Type: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /api/experimental/tasks/{user}/{task}/send

Body parameter

{
  "input": "string"
}

Parameters

Name In Type Required Description
user path string true Username, user ID, or 'me' for the authenticated user
task path string true Task ID, or task name
body body codersdk.TaskSendRequest true Task input request

Responses

Status Meaning Description Schema
204 No Content Input sent successfully

To perform this operation, you must be authenticated. Learn more.

Reference in New Issue View Git Blame Copy Permalink