opensource/coder
3
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-10-16 14:48:56 +08:00
Code Issues Packages Projects Releases Wiki Activity
Files
8cdb374b7ce986c4fdb09b812ba31e08381a868a
coder/docs/reference/api/chats.md
T

27 KiB
Generated
Raw Blame History

Chats

List chats

Code samples

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

GET /chats

Example responses

200 Response

[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "diff_status": {
      "additions": 0,
      "changed_files": 0,
      "changes_requested": true,
      "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
      "deletions": 0,
      "pull_request_state": "string",
      "refreshed_at": "2019-08-24T14:15:22Z",
      "stale_at": "2019-08-24T14:15:22Z",
      "url": "string"
    },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "model_config": [
      0
    ],
    "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
    "parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
    "root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
    "status": "waiting",
    "title": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1",
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "workspace_mode": "workspace"
  }
]

Responses

Status Meaning Description Schema
200 OK OK array of codersdk.Chat

Response Schema

Status Code 200

Name Type Required Restrictions Description
[array item] array false
» created_at string(date-time) false
» diff_status codersdk.ChatDiffStatus false
»» additions integer false
»» changed_files integer false
»» changes_requested boolean false
»» chat_id string(uuid) false
»» deletions integer false
»» pull_request_state string false
»» refreshed_at string(date-time) false
»» stale_at string(date-time) false
»» url string false
» id string(uuid) false
» model_config array false
» owner_id string(uuid) false
» parent_chat_id string(uuid) false
» root_chat_id string(uuid) false
» status codersdk.ChatStatus false
» title string false
» updated_at string(date-time) false
» workspace_agent_id string(uuid) false
» workspace_id string(uuid) false
» workspace_mode codersdk.ChatWorkspaceMode false

Enumerated Values

Property Value(s)
status completed, error, paused, pending, running, waiting
workspace_mode local, workspace

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

Create a chat

Code samples

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

POST /chats

Body parameter

{
  "input": {
    "parts": [
      {
        "text": "string",
        "type": "text"
      }
    ]
  },
  "message": "string",
  "model": "string",
  "model_config": [
    0
  ],
  "parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
  "system_prompt": "string",
  "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_mode": "workspace"
}

Parameters

Name In Type Required Description
body body codersdk.CreateChatRequest true Create chat request

Example responses

201 Response

{
  "created_at": "2019-08-24T14:15:22Z",
  "diff_status": {
    "additions": 0,
    "changed_files": 0,
    "changes_requested": true,
    "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
    "deletions": 0,
    "pull_request_state": "string",
    "refreshed_at": "2019-08-24T14:15:22Z",
    "stale_at": "2019-08-24T14:15:22Z",
    "url": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "model_config": [
    0
  ],
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
  "root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
  "status": "waiting",
  "title": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_mode": "workspace"
}

Responses

Status Meaning Description Schema
201 Created Created codersdk.Chat

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

List chat models

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/models \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /chats/models

Example responses

200 Response

{
  "providers": [
    {
      "available": true,
      "models": [
        {
          "display_name": "string",
          "id": "string",
          "model": "string",
          "provider": "string"
        }
      ],
      "provider": "string",
      "unavailable_reason": "missing_api_key"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.ChatModelsResponse

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

Watch chat list updates

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/watch \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /chats/watch

Example responses

200 Response

{
  "data": null,
  "type": "ping"
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.ServerSentEvent

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

Get a chat

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat} \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /chats/{chat}

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID

Example responses

200 Response

{
  "chat": {
    "created_at": "2019-08-24T14:15:22Z",
    "diff_status": {
      "additions": 0,
      "changed_files": 0,
      "changes_requested": true,
      "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
      "deletions": 0,
      "pull_request_state": "string",
      "refreshed_at": "2019-08-24T14:15:22Z",
      "stale_at": "2019-08-24T14:15:22Z",
      "url": "string"
    },
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "model_config": [
      0
    ],
    "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
    "parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
    "root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
    "status": "waiting",
    "title": "string",
    "updated_at": "2019-08-24T14:15:22Z",
    "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1",
    "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
    "workspace_mode": "workspace"
  },
  "messages": [
    {
      "cache_creation_tokens": 0,
      "cache_read_tokens": 0,
      "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
      "content": [
        0
      ],
      "context_limit": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "hidden": true,
      "id": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "parts": [
        {
          "args": [
            0
          ],
          "args_delta": "string",
          "data": [
            0
          ],
          "is_error": true,
          "media_type": "string",
          "result": [
            0
          ],
          "result_delta": "string",
          "result_meta": {
            "content": "string",
            "created": true,
            "error": "string",
            "exit_code": 0,
            "mime_type": "string",
            "output": "string",
            "reason": "string",
            "workspace_agent_id": "string",
            "workspace_id": "string",
            "workspace_name": "string",
            "workspace_url": "string"
          },
          "signature": "string",
          "source_id": "string",
          "text": "string",
          "title": "string",
          "tool_call_id": "string",
          "tool_name": "string",
          "type": "text",
          "url": "string"
        }
      ],
      "reasoning_tokens": 0,
      "role": "string",
      "thinking": "string",
      "tool_call_id": "string",
      "total_tokens": 0
    }
  ],
  "queued_messages": [
    {
      "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
      "content": [
        0
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "id": 0
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.ChatWithMessages

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

Delete a chat

Code samples

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

DELETE /chats/{chat}

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID

Responses

Status Meaning Description Schema
204 No Content No Content

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

Get diff contents for a chat

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/diff \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /chats/{chat}/diff

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID

Example responses

200 Response

{
  "branch": "string",
  "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
  "diff": "string",
  "provider": "string",
  "pull_request_url": "string",
  "remote_origin": "string"
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.ChatDiffContents

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

Get diff status for a chat

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/diff-status \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /chats/{chat}/diff-status

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID

Example responses

200 Response

{
  "additions": 0,
  "changed_files": 0,
  "changes_requested": true,
  "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
  "deletions": 0,
  "pull_request_state": "string",
  "refreshed_at": "2019-08-24T14:15:22Z",
  "stale_at": "2019-08-24T14:15:22Z",
  "url": "string"
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.ChatDiffStatus

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

Interrupt a chat

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/{chat}/interrupt \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /chats/{chat}/interrupt

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID

Example responses

200 Response

{
  "created_at": "2019-08-24T14:15:22Z",
  "diff_status": {
    "additions": 0,
    "changed_files": 0,
    "changes_requested": true,
    "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
    "deletions": 0,
    "pull_request_state": "string",
    "refreshed_at": "2019-08-24T14:15:22Z",
    "stale_at": "2019-08-24T14:15:22Z",
    "url": "string"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "model_config": [
    0
  ],
  "owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
  "parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
  "root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
  "status": "waiting",
  "title": "string",
  "updated_at": "2019-08-24T14:15:22Z",
  "workspace_agent_id": "7ad2e618-fea7-4c1a-b70a-f501566a72f1",
  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
  "workspace_mode": "workspace"
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.Chat

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

Create a chat message

Code samples

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

POST /chats/{chat}/messages

Body parameter

{
  "content": [
    0
  ],
  "role": "string",
  "thinking": "string",
  "tool_call_id": "string"
}

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID
body body codersdk.CreateChatMessageRequest true Create chat message request

Example responses

200 Response

{
  "messages": [
    {
      "cache_creation_tokens": 0,
      "cache_read_tokens": 0,
      "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
      "content": [
        0
      ],
      "context_limit": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "hidden": true,
      "id": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "parts": [
        {
          "args": [
            0
          ],
          "args_delta": "string",
          "data": [
            0
          ],
          "is_error": true,
          "media_type": "string",
          "result": [
            0
          ],
          "result_delta": "string",
          "result_meta": {
            "content": "string",
            "created": true,
            "error": "string",
            "exit_code": 0,
            "mime_type": "string",
            "output": "string",
            "reason": "string",
            "workspace_agent_id": "string",
            "workspace_id": "string",
            "workspace_name": "string",
            "workspace_url": "string"
          },
          "signature": "string",
          "source_id": "string",
          "text": "string",
          "title": "string",
          "tool_call_id": "string",
          "tool_name": "string",
          "type": "text",
          "url": "string"
        }
      ],
      "reasoning_tokens": 0,
      "role": "string",
      "thinking": "string",
      "tool_call_id": "string",
      "total_tokens": 0
    }
  ],
  "queued": true,
  "queued_message": {
    "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
    "content": [
      0
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "id": 0
  }
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.CreateChatMessageResponse

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

Delete a queued chat message

Code samples

# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/chats/{chat}/queue/{queuedMessage} \
  -H 'Coder-Session-Token: API_KEY'

DELETE /chats/{chat}/queue/{queuedMessage}

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID
queuedMessage path integer true Queued message ID

Responses

Status Meaning Description Schema
204 No Content No Content

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

Promote a queued message to send immediately

Code samples

# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/{chat}/queue/{queuedMessage}/promote \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

POST /chats/{chat}/queue/{queuedMessage}/promote

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID
queuedMessage path integer true Queued message ID

Example responses

200 Response

{
  "messages": [
    {
      "cache_creation_tokens": 0,
      "cache_read_tokens": 0,
      "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
      "content": [
        0
      ],
      "context_limit": 0,
      "created_at": "2019-08-24T14:15:22Z",
      "hidden": true,
      "id": 0,
      "input_tokens": 0,
      "output_tokens": 0,
      "parts": [
        {
          "args": [
            0
          ],
          "args_delta": "string",
          "data": [
            0
          ],
          "is_error": true,
          "media_type": "string",
          "result": [
            0
          ],
          "result_delta": "string",
          "result_meta": {
            "content": "string",
            "created": true,
            "error": "string",
            "exit_code": 0,
            "mime_type": "string",
            "output": "string",
            "reason": "string",
            "workspace_agent_id": "string",
            "workspace_id": "string",
            "workspace_name": "string",
            "workspace_url": "string"
          },
          "signature": "string",
          "source_id": "string",
          "text": "string",
          "title": "string",
          "tool_call_id": "string",
          "tool_name": "string",
          "type": "text",
          "url": "string"
        }
      ],
      "reasoning_tokens": 0,
      "role": "string",
      "thinking": "string",
      "tool_call_id": "string",
      "total_tokens": 0
    }
  ],
  "queued": true,
  "queued_message": {
    "chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
    "content": [
      0
    ],
    "created_at": "2019-08-24T14:15:22Z",
    "id": 0
  }
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.CreateChatMessageResponse

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

Stream chat updates

Code samples

# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/stream \
  -H 'Accept: application/json' \
  -H 'Coder-Session-Token: API_KEY'

GET /chats/{chat}/stream

Parameters

Name In Type Required Description
chat path string(uuid) true Chat ID

Example responses

200 Response

{
  "data": null,
  "type": "ping"
}

Responses

Status Meaning Description Schema
200 OK OK codersdk.ServerSentEvent

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

Reference in New Issue View Git Blame Copy Permalink