How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Coder Chats API

The Chats API from Coder — 20 operation(s) for chats.

Coder Chats API is one of 32 APIs that Coder publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chats. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 25 operations across 20 paths, and defines 62 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://{coderHost}/api/v2.

25 operations 20 paths 62 schemas 15 GET3 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://coder.example.com/api/v2
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Coder Chats API declares 1 security scheme for authenticating requests. An API key is passed in the header as Coder-Session-Token (CoderSessionToken). By default, every request must be authenticated.

Paths & Operations 25

Across 20 paths, the API surfaces 25 operations — 15 GET, 3 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Chats 25
GET
/api/experimental/chats
List chats
list-chats 2 params → 200
POST
/api/experimental/chats
Create chat
create-chat body → 201
GET
/api/experimental/chats/config/retention-days
Get chat retention days
get-chat-retention-days → 200
PUT
/api/experimental/chats/config/retention-days
Update chat retention days
update-chat-retention-days body → 204
POST
/api/experimental/chats/files
Upload chat file
upload-chat-file 1 param → 201
GET
/api/experimental/chats/files/{file}
Get chat file
get-chat-file 1 param → 200
GET
/api/experimental/chats/insights/pull-requests
Get PR insights
get-pr-insights 2 params → 200
GET
/api/experimental/chats/models
List chat models
list-chat-models → 200
GET
/api/experimental/chats/watch
Watch chat events for a user via WebSockets
watch-chat-events-for-a-user-via-websockets → 200
GET
/api/experimental/chats/{chat}
Get chat by ID
get-chat-by-id 1 param → 200
PATCH
/api/experimental/chats/{chat}
Update chat
update-chat 1 param body → 204
GET
/api/experimental/chats/{chat}/acl
Get chat ACLs
get-chat-acls 1 param → 200
PATCH
/api/experimental/chats/{chat}/acl
Update chat ACL
update-chat-acl 1 param body → 204
GET
/api/experimental/chats/{chat}/diff
Get chat diff contents
get-chat-diff-contents 1 param → 200
POST
/api/experimental/chats/{chat}/interrupt
Interrupt chat
interrupt-chat 1 param → 200
GET
/api/experimental/chats/{chat}/messages
List chat messages
list-chat-messages 4 params → 200
POST
/api/experimental/chats/{chat}/messages
Send chat message
send-chat-message 1 param body → 200
PATCH
/api/experimental/chats/{chat}/messages/{message}
Edit chat message
edit-chat-message 2 params body → 200
GET
/api/experimental/chats/{chat}/prompts
List chat user prompts
list-chat-user-prompts 2 params → 200
POST
/api/experimental/chats/{chat}/reconcile-invalid
Reconcile invalid chat state
reconcile-invalid-chat-state 1 param → 200
GET
/api/experimental/chats/{chat}/stream
Stream chat events via WebSockets
stream-chat-events-via-websockets 1 param → 200
GET
/api/experimental/chats/{chat}/stream/desktop
Connect to chat workspace desktop via WebSockets
connect-to-chat-workspace-desktop-via-websockets 1 param → 101
GET
/api/experimental/chats/{chat}/stream/git
Watch chat workspace git state via WebSockets
watch-chat-workspace-git-state-via-websockets 1 param → 200
GET
/api/experimental/chats/{chat}/stream/parts
Stream chat parts via WebSockets
stream-chat-parts-via-websockets 1 param → 200
POST
/api/experimental/chats/{chat}/title/regenerate
Regenerate chat title
regenerate-chat-title 1 param → 200

Schemas 62

The contract defines 62 schemas that model the data the API accepts and returns. The most detailed are codersdk.ChatMessagePart (39 properties), codersdk.Chat (30 properties), codersdk.ChatDiffStatus (19 properties), codersdk.PRInsightsPullRequest (19 properties). Each schema is shown below with its type and property counts.

codersdk.PRInsightsModelBreakdown
object
10 properties
codersdk.ChatError
object
6 properties
codersdk.PRInsightsResponse
object
4 properties
codersdk.Chat
object
30 properties
codersdk.ChatStatus
string
codersdk.WorkspaceAgentGitServerMessage
object
4 properties
codersdk.EditChatMessageRequest
object
2 properties
codersdk.UploadChatFileResponse
object
1 property
codersdk.ChatRetentionDaysResponse
object
1 property
codersdk.ChatUser
object
5 properties 2 required
codersdk.ChatMessagesResponse
object
3 properties
codersdk.ChatModel
object
4 properties
codersdk.PRInsightsSummary
object
12 properties
codersdk.ChatWatchEventKind
string
codersdk.ChatPrompt
object
2 properties
codersdk.UpdateChatACL
object
2 properties
codersdk.ChatPromptsResponse
object
1 property
codersdk.UpdateChatRequest
object
6 properties
codersdk.ChatModelProviderUnavailableReason
string
codersdk.WorkspaceAgentGitServerMessageType
string
codersdk.ChatRole
string
codersdk.PRInsightsTimeSeriesEntry
object
4 properties
codersdk.ChatQueuedMessage
object
5 properties
codersdk.ChatStreamMessagePart
object
5 properties
codersdk.ChatStreamEvent
object
9 properties
codersdk.ChatWatchEvent
object
3 properties
codersdk.ChatClientType
string
codersdk.ChatModelsResponse
object
1 property
codersdk.DynamicTool
object
3 properties
codersdk.ChatFileMetadata
object
6 properties
codersdk.ChatMessageUsage
object
7 properties
codersdk.ChatACL
object
2 properties
codersdk.GroupSource
string
codersdk.ChatStreamEventType
string
codersdk.ChatStreamRetry
object
7 properties
codersdk.PRInsightsPullRequest
object
19 properties
codersdk.UpdateChatRetentionDaysRequest
object
1 property
codersdk.ChatMessagePartType
string
codersdk.ChatBusyBehavior
string
codersdk.ChatDiffStatus
object
19 properties
codersdk.WorkspaceAgentRepoChanges
object
5 properties
codersdk.ChatStreamStatus
object
1 property
codersdk.ChatInputPartType
string
codersdk.LoginType
string
codersdk.CreateChatRequest
object
10 properties
codersdk.ChatMessage
object
8 properties
codersdk.CreateChatMessageRequest
object
5 properties
codersdk.ChatMessageRole
string
codersdk.ChatErrorKind
string
codersdk.CreateChatMessageResponse
object
4 properties
codersdk.ChatModelProvider
object
4 properties
codersdk.ChatGroup
object
12 properties
codersdk.ChatPlanMode
string
codersdk.ChatStreamActionRequired
object
1 property
uuid.NullUUID
object
2 properties
codersdk.UserStatus
string
codersdk.ChatDiffContents
object
6 properties
codersdk.ChatStreamToolCall
object
3 properties
codersdk.ChatMessagePart
object
39 properties
codersdk.ChatInputPart
object
7 properties
codersdk.ReducedUser
object
12 properties 4 required
codersdk.EditChatMessageResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

coder-chats-api-openapi.yml Raw ↑

Other APIs Coder publishes across the network.

Coder Workspaces API
Coder Templates API
Coder Users API
Coder Workspace Agents API
Coder Enterprise API
Coder Agents API
Coder AI Bridge API
Coder AI Providers API
Coder Applications API
Coder Audit API
Coder Authorization API
Coder Builds API
Where this information came from

This is an independent, third-party profile of Coder Chats API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.