mirror of
https://github.com/coder/coder.git
synced 2026-06-03 13:08:25 +00:00
Mathias Fredriksson
51d3abb904
Updates the UI to use the new API endpoints for tasks and use its new data model. Disclaimer: Since the base data model for tasks changed, we had to do a quite large refactor and I'm sorry for that 🙏, but you'll notice most of the changes are to adjust the types. Closes coder/internal#976 --------- Co-authored-by: Bruno Quaresma <bruno_nonato_quaresma@hotmail.com>
8.0 KiB
Generated
8.0 KiB
Generated
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(uuid) | true | Task ID |
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(uuid) | true | Task ID |
Responses
| Status | Meaning | Description | Schema |
|---|---|---|---|
| 202 | Accepted | Task deletion initiated |
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(uuid) | true | Task ID |
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(uuid) | true | Task ID |
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.