Programmatic API for Coder Agents (the user-facing "Coder Agents" / "Chats" product). Use these endpoints to create, list, and manage AI coding agent sessions.
# Example request using curl
curl -X GET http://coder-server:8080/api/experimental/chats/{chat}/stream/desktop \
-H 'Coder-Session-Token: API_KEY'
GET /api/experimental/chats/{chat}/stream/desktop
Raw binary WebSocket stream of the chat workspace desktop.
Experimental: this endpoint is subject to change.
Name In Type Required Description chatpath string(uuid) true Chat ID
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats
Name In Type Required Description qquery string false Search query. Supports title:<substring> (case-insensitive, quote multi-word values), archived:bool (archived:any matches archived and active chats), has_unread:bool, status:<waiting|running|error|requires_action|interrupting> (chat status, repeated or comma-separated), pr_status:<draft|open|merged|closed|none> (none matches chats with no pull request) as repeated or comma-separated values, source:<created_by_me|shared_with_me>, diff_url:<url> (quote values containing colons), pr:<number> (exact PR number match), repo:<owner/repo> (case-insensitive substring match against git remote origin or URL), pr_title:<text> (case-insensitive PR title substring), search:<text> (full-text search across chat titles, PR titles, PR numbers, and message bodies; message bodies match English word stems, e.g. refactor matches refactoring, and ignore English stopwords; titles and PR titles match whole words case-insensitively without stemming; quote multi-word values; cannot be combined with title, pr_title, or pr; a value that tokenizes to no searchable words, e.g. punctuation only, returns an empty list). Bare terms are not supported; use title:<value> or search:<value>. labelquery array[string] false Filter by label as key:value. Repeat for multiple (AND logic). after_idquery string(uuid) false After ID limitquery integer false Page limit offsetquery integer false Page offset automation_idquery string(uuid) false Filter to chats the automation created or sent messages to. Ignored unless the chat-automations experiment is enabled for the caller. project_idquery string(uuid) false Only chats in this project. Requires the chat-projects experiment.
200 Response
[
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
]
Status Code 200
Name Type Required Restrictions Description [array item]array false » agent_idstring(uuid) false » archivedboolean false » build_idstring(uuid) false » childrencodersdk.Chat false Children holds child (subagent) chats nested under this root chat. Always initialized to an empty slice so the JSON field is present as []. Child chats cannot create their own subagents, so nesting depth is capped at 1 and this slice is always empty for child chats. » client_typecodersdk.ChatClientType false » contextcodersdk.ChatContext false Context reports the chat's pinned workspace-context state and whether it has drifted from the agent's latest pushed snapshot. Nil when the chat has no pinned context yet. »» dirtyboolean false Dirty is true when the agent's latest snapshot hash differs from the chat's pinned hash. »» dirty_sincestring(date-time) false Dirty since is when drift was first detected; nil when not dirty. »» errorstring false Error is the snapshot-level error copied from the pinned snapshot (empty when healthy). »» resourcesarray false Resources is the chat's pinned context (instruction files and skills) the prompt is built from, metadata only (no bodies). It is populated only on the single-chat GET response; list and watch payloads leave it nil to stay lightweight. »»» errorstring false Error explains a non-ok Status; empty when healthy. May also carry a non-fatal warning when Status is ok. »»» kindcodersdk.ChatContextResourceKind false »»» size_bytesinteger false Size bytes is the original payload size in bytes. »»» skill_descriptionstring false »»» skill_namestring false Skill name and SkillDescription are populated only for skill kinds. »»» sourcestring false Source is the resource locator: the canonical file path for an instruction file, the skill directory for a skill, the file path for an MCP config, or the server name for an MCP server. »»» statuscodersdk.ChatContextResourceStatus false Status is the resource's health. Non-ok resources (invalid, unreadable, oversize, excluded) are still reported so the UI can surface why a resource was dropped from the prompt instead of silently omitting it; their body-specific fields (skill name, tools) are empty. »»» toolsarray false Tools lists the tools exposed by an MCP server. Populated only for the mcp_server kind; nil otherwise. »»»» descriptionstring false Description is the tool's human-readable summary; may be empty. »»»» namestring false Name is the tool name with the <server>__ prefix the agent adds stripped, so it reads as the server exposes it. » created_atstring(date-time) false » diff_statuscodersdk.ChatDiffStatus false »» additionsinteger false »» approvedboolean false »» author_avatar_urlstring false »» author_loginstring false »» base_branchstring false »» changed_filesinteger false »» changes_requestedboolean false »» chat_idstring(uuid) false »» commitsinteger false »» deletionsinteger false »» head_branchstring false »» pr_numberinteger false »» pull_request_draftboolean false »» pull_request_statestring false »» pull_request_titlestring false »» refreshed_atstring(date-time) false »» reviewer_countinteger false »» stale_atstring(date-time) false »» urlstring false » filesarray false »» created_atstring(date-time) false »» idstring(uuid) false »» mime_typestring false »» namestring false »» organization_idstring(uuid) false »» owner_idstring(uuid) false »» size_bytesinteger false » has_unreadboolean false Has unread is true when assistant messages exist beyond the owner's read cursor, which updates on stream connect and disconnect and via UpdateChatRequest.Read. » idstring(uuid) false » inline_mcp_serversarray false Inline mcp servers lists the inline MCP servers declared on the chat, without headers. Only the single-chat GET sets it. Experimental. »» allow_in_subagentsboolean false »» created_atstring(date-time) false »» forward_coder_headersboolean false »» has_custom_headersboolean false »» idstring(uuid) false »» slugstring false »» tool_allow_listarray false »» tool_deny_listarray false »» updated_atstring(date-time) false »» urlstring false URL is empty unless the chat owner makes the request. » labelsobject false »» [any property]string false » last_errorcodersdk.ChatError false »» detailstring false Detail is optional provider-specific context shown alongside the normalized error message when available. »» kindcodersdk.ChatErrorKind false Kind classifies the error for consistent client rendering. »» messagestring false Message is the normalized, user-facing error message. »» providerstring false Provider identifies the upstream model provider when known. »» retryableboolean false Retryable reports whether the underlying error is transient. »» status_codeinteger false Status code is the best-effort upstream HTTP status code. » last_model_config_idstring(uuid) false » last_reasoning_effortstring false » last_turn_summarystring false » manage_automations_enabledboolean false Manage automations enabled offers the manage_automations tool to this chat's agent. Experimental. » mcp_server_idsarray false » organization_idstring(uuid) false » owner_idstring(uuid) false » owner_namestring false » owner_usernamestring false » parent_chat_idstring(uuid) false » pin_orderinteger false » plan_modecodersdk.ChatPlanMode false » project_idstring(uuid) false » queued_for_capacityboolean false Queued for capacity reports that the chat is waiting for a concurrent agent slot. Single-chat reads derive it; list responses leave it false. » root_chat_idstring(uuid) false » sharedboolean false Shared is true when this chat's root chat has explicit user or group ACL entries. » statuscodersdk.ChatStatus false » summarystring false Summary is the persisted whole-chat summary, generated in the background. It is nil until the first summary has been produced. » titlestring false » title_sourcecodersdk.ChatTitleSource false Title source is where Title came from. A title write applies only when the current source ranks the same as or lower than the incoming one, in the order fallback, generated, user. » title_updated_atstring(date-time) false Title updated at orders title changes. Title writes do not change UpdatedAt. » updated_atstring(date-time) false » warningsarray false » workspace_idstring(uuid) false
Property Value(s) client_typeapi, uikindauth, config, content_filter, generic, hook_denied, hook_dispatch_failed, instruction_file, mcp_config, mcp_server, missing_key, overloaded, provider_disabled, rate_limit, skill, stream_silence_timeout, timeout, usage_limitstatuserror, excluded, interrupting, invalid, ok, oversize, requires_action, running, unreadable, waitingplan_modeplantitle_sourcefallback, generated, user
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats
Body parameter
{
"client_type": "ui",
"content": [
{
"content": "string",
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"start_line": 0,
"text": "string",
"type": "text",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"forward_coder_headers": true,
"headers": {
"property1": "string",
"property2": "string"
},
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"reasoning_effort": "string",
"system_prompt": "string",
"title": "string",
"unsafe_dynamic_tools": [
{
"description": "string",
"input_schema": [
0
],
"name": "string"
}
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
201 Response
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/by-workspace \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/by-workspace
Name In Type Required Description workspace_idsquery string false Comma-separated workspace IDs
200 Response
{
"property1": "string",
"property2": "string"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/auto-archive-days \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/auto-archive-days
200 Response
{
"auto_archive_days": 0
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/auto-archive-days \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/auto-archive-days
Body parameter
{
"auto_archive_days": 0
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/debug-logging \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/debug-logging
200 Response
{
"allow_users": true,
"forced_by_deployment": true
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/debug-logging \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/debug-logging
Body parameter
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/debug-retention-days \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/debug-retention-days
200 Response
{
"debug_retention_days": 0
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/debug-retention-days \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/debug-retention-days
Body parameter
{
"debug_retention_days": 0
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/personal-model-overrides \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/personal-model-overrides
200 Response
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/personal-model-overrides \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/personal-model-overrides
Body parameter
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/plan-mode-instructions \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/plan-mode-instructions
200 Response
{
"plan_mode_instructions": "string"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/plan-mode-instructions \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/plan-mode-instructions
Body parameter
{
"plan_mode_instructions": "string"
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/system-prompt \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/system-prompt
200 Response
{
"default_system_prompt": "string",
"include_default_system_prompt": true,
"system_prompt": "string"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/system-prompt \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/system-prompt
Body parameter
{
"include_default_system_prompt": true,
"system_prompt": "string"
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/user-debug-logging \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/user-debug-logging
200 Response
{
"debug_logging_enabled": true,
"forced_by_deployment": true,
"user_toggle_allowed": true
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/user-debug-logging \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/user-debug-logging
Body parameter
{
"debug_logging_enabled": true
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/user-prompt \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/user-prompt
200 Response
{
"custom_prompt": "string"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/user-prompt \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/user-prompt
Body parameter
{
"custom_prompt": "string"
}
200 Response
{
"custom_prompt": "string"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/config/workspace-ttl \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/config/workspace-ttl
200 Response
{
"workspace_ttl_ms": 0
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/config/workspace-ttl \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/config/workspace-ttl
Body parameter
{
"workspace_ttl_ms": 0
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/files?organization=497f6eca-6276-4993-bfeb-53cbbbba6f08 \
-H 'Content-Type: image/png' \
-H 'Accept: application/json' \
-H 'Content-Disposition: attachment; filename="image.png"' \
-H 'Coder-Session-Token: API_KEY' \
--data-binary '@image.png'
POST /api/v2/chats/files
Name In Type Required Description organizationquery string(uuid) true Organization ID Content-Dispositionheader string true Attachment disposition carrying the file name bodybody string true Raw file binary data
201 Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/files/{file} \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/files/{file}
Name In Type Required Description filepath string(uuid) true File ID
Status Meaning Description Schema 200 OK OK
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/watch
200 Response
{
"chat": {
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
},
"kind": "status_change",
"tool_calls": [
{
"args": "string",
"tool_call_id": "string",
"tool_name": "string"
}
]
}
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/{chat}
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/chats/{chat} \
-H 'Content-Type: application/json' \
-H 'Accept: */*' \
-H 'Coder-Session-Token: API_KEY'
PATCH /api/v2/chats/{chat}
Body parameter
{
"archived": true,
"labels": {
"property1": "string",
"property2": "string"
},
"manage_automations_enabled": true,
"pin_order": 0,
"plan_mode": "plan",
"read": true,
"title": "string",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
400 Response
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/chats/{chat}/context \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/chats/{chat}/context
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/cost \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/{chat}/cost
Cost covers the whole chat tree: the root chat plus every
subagent chat beneath it. Requesting cost for a subagent chat
returns that same total.
Cost is derived from AI Gateway data, which is subject to its
own retention period, 60 days by default, configured
independently of chat retention. Spend for requests older than
that period is no longer reported, so a chat whose requests
have all been purged reports zero cost.
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"request_count": 0,
"total_cost_micros": 0,
"unpriced_request_count": 0
}
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/{chat}/diff
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"branch": "string",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"diff": "string",
"provider": "string",
"pull_request_url": "string",
"remote_origin": "string"
}
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/{chat}/interrupt
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/messages \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/{chat}/messages
Name In Type Required Description chatpath string(uuid) true Chat ID before_idquery integer false Return messages with id < before_id after_idquery integer false Return messages with id > after_id limitquery integer false Page size, 1 to 200. Defaults to 50.
200 Response
{
"has_more": true,
"messages": [
{
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"queued_message_id": 0,
"role": "system",
"usage": {
"cache_creation_tokens": 0,
"cache_read_tokens": 0,
"context_limit": 0,
"input_tokens": 0,
"output_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0
}
}
],
"queued_messages": [
{
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205"
}
]
}
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/{chat}/messages
Body parameter
{
"busy_behavior": "queue",
"content": [
{
"content": "string",
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"start_line": 0,
"text": "string",
"type": "text",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"forward_coder_headers": true,
"headers": {
"property1": "string",
"property2": "string"
},
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"url": "string"
}
],
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"plan_mode": "plan",
"reasoning_effort": "string"
}
200 Response
{
"message": {
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"queued_message_id": 0,
"role": "system",
"usage": {
"cache_creation_tokens": 0,
"cache_read_tokens": 0,
"context_limit": 0,
"input_tokens": 0,
"output_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0
}
},
"messages": [
{
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"queued_message_id": 0,
"role": "system",
"usage": {
"cache_creation_tokens": 0,
"cache_read_tokens": 0,
"context_limit": 0,
"input_tokens": 0,
"output_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0
}
}
],
"queued": true,
"queued_message": {
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205"
},
"warnings": [
"string"
]
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PATCH http://coder-server:8080/api/v2/chats/{chat}/messages/{message} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
PATCH /api/v2/chats/{chat}/messages/{message}
Body parameter
{
"content": [
{
"content": "string",
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"start_line": 0,
"text": "string",
"type": "text",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"reasoning_effort": "string"
}
Name In Type Required Description chatpath string(uuid) true Chat ID messagepath integer true Message ID bodybody codersdk.EditChatMessageRequest true Edit chat message request
200 Response
{
"deleted_message_ids": [
0
],
"message": {
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"queued_message_id": 0,
"role": "system",
"usage": {
"cache_creation_tokens": 0,
"cache_read_tokens": 0,
"context_limit": 0,
"input_tokens": 0,
"output_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0
}
},
"messages": [
{
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"queued_message_id": 0,
"role": "system",
"usage": {
"cache_creation_tokens": 0,
"cache_read_tokens": 0,
"context_limit": 0,
"input_tokens": 0,
"output_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0
}
}
],
"warnings": [
"string"
]
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/prompts \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/{chat}/prompts
Returns the user-authored prompts in a chat, newest first,
with each prompt's text parts concatenated in the order they
were authored. Used by the composer to power the up/down
arrow prompt-history cycle without paging through every
message in the chat.
Name In Type Required Description chatpath string(uuid) true Chat ID limitquery integer false Page size, 0 to 2000. 0 (the default) means the server-side default of 500.
200 Response
{
"prompts": [
{
"id": 0,
"text": "string"
}
]
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/chats/{chat}/queue/{queuedMessage} \
-H 'Coder-Session-Token: API_KEY'
DELETE /api/v2/chats/{chat}/queue/{queuedMessage}
Name In Type Required Description chatpath string(uuid) true Chat ID queuedMessagepath integer true Queued message ID
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/{chat}/queue/{queuedMessage}/promote
Name In Type Required Description chatpath string(uuid) true Chat ID queuedMessagepath integer true Queued message ID
202 Response
{
"detail": "string",
"message": "string",
"validations": [
{
"detail": "string",
"field": "string"
}
]
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/{chat}/reconcile-invalid \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
POST /api/v2/chats/{chat}/reconcile-invalid
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [
{
"agent_id": "2b1e3b65-2c04-4fa2-a2d7-467901e98978",
"archived": true,
"build_id": "bfb1f3fa-bf7b-43a5-9e0b-26cc050e44cb",
"children": [],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
],
"client_type": "ui",
"context": {
"dirty": true,
"dirty_since": "2019-08-24T14:15:22Z",
"error": "string",
"resources": [
{
"error": "string",
"kind": "instruction_file",
"size_bytes": 0,
"skill_description": "string",
"skill_name": "string",
"source": "string",
"status": "ok",
"tools": [
{
"description": "string",
"name": "string"
}
]
}
]
},
"created_at": "2019-08-24T14:15:22Z",
"diff_status": {
"additions": 0,
"approved": true,
"author_avatar_url": "string",
"author_login": "string",
"base_branch": "string",
"changed_files": 0,
"changes_requested": true,
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"commits": 0,
"deletions": 0,
"head_branch": "string",
"pr_number": 0,
"pull_request_draft": true,
"pull_request_state": "string",
"pull_request_title": "string",
"refreshed_at": "2019-08-24T14:15:22Z",
"reviewer_count": 0,
"stale_at": "2019-08-24T14:15:22Z",
"url": "string"
},
"files": [
{
"created_at": "2019-08-24T14:15:22Z",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"mime_type": "string",
"name": "string",
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"size_bytes": 0
}
],
"has_unread": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"inline_mcp_servers": [
{
"allow_in_subagents": true,
"created_at": "2019-08-24T14:15:22Z",
"forward_coder_headers": true,
"has_custom_headers": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"slug": "string",
"tool_allow_list": [
"string"
],
"tool_deny_list": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z",
"url": "string"
}
],
"labels": {
"property1": "string",
"property2": "string"
},
"last_error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"last_model_config_id": "30ebb95f-c255-4759-9429-89aa4ec1554c",
"last_reasoning_effort": "string",
"last_turn_summary": "string",
"manage_automations_enabled": true,
"mcp_server_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"owner_username": "string",
"parent_chat_id": "c3609ee6-3b11-4a93-b9ae-e4fabcc99359",
"pin_order": 0,
"plan_mode": "plan",
"project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
"queued_for_capacity": true,
"root_chat_id": "2898031c-fdce-4e3e-8c53-4481dd42fcd7",
"shared": true,
"status": "waiting",
"summary": "string",
"title": "string",
"title_source": "fallback",
"title_updated_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"warnings": [
"string"
],
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
To perform this operation, you must be authenticated. Learn more .
# 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 /api/v2/chats/{chat}/stream
Name In Type Required Description chatpath string(uuid) true Chat ID after_idquery integer false Skip snapshot messages with id at or before this cursor
200 Response
[
{
"action_required": {
"tool_calls": [
{
"args": "string",
"tool_call_id": "string",
"tool_name": "string"
}
]
},
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"error": {
"detail": "string",
"kind": "generic",
"message": "string",
"provider": "string",
"retryable": true,
"status_code": 0
},
"message": {
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205",
"queued_message_id": 0,
"role": "system",
"usage": {
"cache_creation_tokens": 0,
"cache_read_tokens": 0,
"context_limit": 0,
"input_tokens": 0,
"output_tokens": 0,
"reasoning_tokens": 0,
"total_tokens": 0
}
},
"message_part": {
"generation_attempt": 0,
"history_version": 0,
"part": {
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
},
"role": "system",
"seq": 0
},
"queued_messages": [
{
"automation_id": "64fb5f73-6415-4f56-8e9e-ca06539f09ac",
"chat_id": "efc9fe20-a1e5-4a8c-9c48-f1b30c1e4f86",
"content": [
{
"args": [
0
],
"args_delta": "string",
"completed_at": "2019-08-24T14:15:22Z",
"content": "string",
"context_file_agent_id": "2e577c68-2ec9-4c84-a77a-5b3e1d7eae09",
"context_file_content": "string",
"context_file_directory": "string",
"context_file_os": "string",
"context_file_path": "string",
"context_file_skill_meta_file": "string",
"context_file_truncated": true,
"created_at": "2019-08-24T14:15:22Z",
"data": [
0
],
"end_line": 0,
"file_id": "8a0cfb4f-ddc9-436d-91bb-75133c583767",
"file_name": "string",
"hook_rewritten": true,
"is_error": true,
"is_media": true,
"mcp_server_config_id": "a9f436ed-69e7-459c-8308-a67ff5387e3e",
"media_type": "string",
"name": "string",
"parsed_commands": [
[
"string"
]
],
"provider_executed": true,
"provider_metadata": [
0
],
"reasoning_delta": "string",
"result": [
0
],
"result_delta": "string",
"result_reset": true,
"skill_description": "string",
"skill_dir": "string",
"skill_name": "string",
"source_id": "string",
"start_line": 0,
"text": "string",
"title": "string",
"tool_call_id": "string",
"tool_name": "string",
"type": "text",
"url": "string",
"workspace_file_media_type": "string",
"workspace_file_name": "string",
"workspace_file_path": "string",
"workspace_file_size": 0,
"workspace_file_workspace_id": "74c05446-1c56-4543-82a9-03f2bf73b2ab"
}
],
"created_at": "2019-08-24T14:15:22Z",
"id": 0,
"input_id": "a7cf618d-a4a2-48f0-8b07-9196b264ab17",
"model_config_id": "f5fb4d91-62ca-4377-9ee6-5d43ba00d205"
}
],
"retry": {
"attempt": 0,
"delay_ms": 0,
"error": "string",
"kind": "generic",
"provider": "string",
"retrying_at": "2019-08-24T14:15:22Z",
"status_code": 0
},
"status": {
"status": "waiting"
},
"type": "message_part"
}
]
Status Code 200
Name Type Required Restrictions Description [array item]array false » action_requiredcodersdk.ChatStreamActionRequired false »» tool_callsarray false »»» argsstring false »»» tool_call_idstring false »»» tool_namestring false » chat_idstring(uuid) false » errorcodersdk.ChatError false »» detailstring false Detail is optional provider-specific context shown alongside the normalized error message when available. »» kindcodersdk.ChatErrorKind false Kind classifies the error for consistent client rendering. »» messagestring false Message is the normalized, user-facing error message. »» providerstring false Provider identifies the upstream model provider when known. »» retryableboolean false Retryable reports whether the underlying error is transient. »» status_codeinteger false Status code is the best-effort upstream HTTP status code. » messagecodersdk.ChatMessage false »» automation_idstring(uuid) false Automation ID is the chat automation that delivered this message, if any. The automation may since have been deleted. »» chat_idstring(uuid) false »» contentarray false »»» argsarray false »»» args_deltastring false »»» completed_atstring(date-time) false Completed at is the time a reasoning part finished streaming, so reasoning duration can be computed as completed_at minus created_at. For interrupted reasoning, this is the interruption time. Absent when reasoning timestamp data was not recorded (e.g. messages persisted before this feature was added). »»» contentstring false The code content from the diff that was commented on. »»» context_file_agent_idstring(uuid) false Context file agent ID is the workspace agent that provided this context file. Used to detect when the agent changes (e.g. workspace rebuilt) so instruction files can be re-persisted with fresh content. »»» context_file_contentstring false Context file content holds the file content sent to the LLM. Internal only: stripped before API responses to keep payloads small. The backend reads it when building the prompt via partsToMessageParts. »»» context_file_directorystring false Context file directory is the working directory of the workspace agent. Internal only: same purpose as ContextFileOS. »»» context_file_osstring false Context file os is the operating system of the workspace agent. Internal only: used during prompt expansion so the LLM knows the OS even on turns where InsertSystem is not called. »»» context_file_pathstring false Context file path is the absolute path of a file loaded into the LLM context (e.g. an AGENTS.md instruction file). »»» context_file_skill_meta_filestring false Context file skill meta file is the basename of the skill meta file (e.g. "SKILL.md") at the time of persistence. Internal only: restored on subsequent turns so the read_skill tool uses the correct filename even when the agent configured a non-default value. »»» context_file_truncatedboolean false Context file truncated indicates the file exceeded the 64KiB instruction file limit and was truncated. »»» created_atstring(date-time) false Created at is the timestamp this part carries. The semantics depend on the part type: for tool-call and tool-result parts it is the time the call was emitted or the result was produced (tool duration is the result's created_at minus the call's created_at); for reasoning parts it is the time reasoning started streaming. »»» dataarray false »»» end_lineinteger false »»» file_idstring(uuid) false »»» file_namestring false »»» hook_rewrittenboolean false Hook rewritten indicates that a lifecycle hook replaced model-proposed tool input. »»» is_errorboolean false »»» is_mediaboolean false »»» mcp_server_config_idstring(uuid) false »»» media_typestring false »»» namestring false »»» parsed_commandsarray false Parsed commands holds parsed programs from an execute tool call's shell command, one entry per simple command in source order. Each entry is [program] or [program, arg] where arg is the first non-flag positional argument. Program names are normalized to their base name (e.g. /usr/bin/go becomes go). Only populated when ToolName is "execute" and the command parses successfully; nil otherwise. »»» provider_executedboolean false Provider executed indicates the tool call was executed by the provider (e.g. Anthropic computer use). »»» provider_metadataarray false Provider metadata holds provider-specific response metadata (e.g. Anthropic cache control hints) as raw JSON. Internal only: stripped by db2sdk before API responses. »»» reasoning_deltastring false »»» resultarray false »»» result_deltastring false »»» result_resetboolean false »»» skill_descriptionstring false Skill description is the short description from the skill's SKILL.md frontmatter. »»» skill_dirstring false Skill dir is the absolute path to the skill directory inside the workspace filesystem. Internal only: used by read_skill/read_skill_file tools to locate skill files. »»» skill_namestring false Skill name is the kebab-case name of a discovered skill from the workspace's .agents/skills/ directory. »»» source_idstring false »»» start_lineinteger false »»» textstring false »»» titlestring false »»» tool_call_idstring false »»» tool_namestring false »»» typecodersdk.ChatMessagePartType false »»» urlstring false »»» workspace_file_media_typestring false Workspace file media type is the best-effort declared MIME type. »»» workspace_file_namestring false Workspace file name is the sanitized basename of a workspace upload. »»» workspace_file_pathstring false Workspace file path is the absolute path of a workspace upload. The bytes live on the workspace filesystem; only metadata is persisted on the message. »»» workspace_file_sizeinteger false Workspace file size is the byte size of a workspace upload. »»» workspace_file_workspace_idstring(uuid) false Workspace file workspace ID identifies the workspace whose filesystem holds the uploaded bytes. References are only readable while the chat stays bound to that workspace. »» created_atstring(date-time) false »» created_bystring(uuid) false »» idinteger false »» input_idstring(uuid) false Input ID identifies the automation input that produced this message: a webhook delivery or a schedule occurrence. It is set only when AutomationID is set. »» model_config_idstring(uuid) false »» queued_message_idinteger false Queued message ID is the ID of the queued message this message was promoted from. It matches ChatQueuedMessage.ID in the response that queued the message. It is nil when the message was not promoted from the queue (edits create a new message without it) or when a server version that did not record the link created it. »» rolecodersdk.ChatMessageRole false »» usagecodersdk.ChatMessageUsage false »»» cache_creation_tokensinteger false »»» cache_read_tokensinteger false »»» context_limitinteger false »»» input_tokensinteger false »»» output_tokensinteger false »»» reasoning_tokensinteger false »»» total_tokensinteger false » message_partcodersdk.ChatStreamMessagePart false »» generation_attemptinteger false »» history_versioninteger false »» partcodersdk.ChatMessagePart false »» rolecodersdk.ChatMessageRole false »» seqinteger false » queued_messagesarray false »» automation_idstring(uuid) false Automation ID is the chat automation that queued this message, if any. The automation may since have been deleted. »» chat_idstring(uuid) false »» contentarray false »» created_atstring(date-time) false »» idinteger false »» input_idstring(uuid) false Input ID identifies the automation input that produced this message: a webhook delivery or a schedule occurrence. It is set only when AutomationID is set. »» model_config_idstring(uuid) false » retrycodersdk.ChatStreamRetry false »» attemptinteger false Attempt is the 1-indexed retry attempt number. »» delay_msinteger false Delay ms is the backoff delay in milliseconds before the retry. »» errorstring false Error is the normalized error message from the failed attempt. »» kindcodersdk.ChatErrorKind false Kind classifies the retry reason for consistent client rendering. »» providerstring false Provider identifies the upstream model provider when known. »» retrying_atstring(date-time) false Retrying at is the timestamp when the retry will be attempted. »» status_codeinteger false Status code is the best-effort upstream HTTP status code. » statuscodersdk.ChatStreamStatus false »» statuscodersdk.ChatStatus false » typecodersdk.ChatStreamEventType false
Property Value(s) kindauth, config, content_filter, generic, hook_denied, hook_dispatch_failed, missing_key, overloaded, provider_disabled, rate_limit, stream_silence_timeout, timeout, usage_limittypeaction_required, context-file, error, file, file-reference, history_reset, hook-context, hook-notice, message, message_part, preview_reset, queue_update, reasoning, retry, skill, source, status, text, tool-call, tool-result, workspace-file-referenceroleassistant, system, tool, userstatuserror, interrupting, requires_action, running, waiting
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/chats/{chat}/stream/git \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/chats/{chat}/stream/git
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
{
"message": "string",
"repositories": [
{
"branch": "string",
"remote_origin": "string",
"removed": true,
"repo_root": "string",
"unified_diff": "string"
}
],
"scanned_at": "2019-08-24T14:15:22Z",
"type": "changes"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/{chat}/title/propose \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
POST /api/v2/chats/{chat}/title/propose
Name In Type Required Description chatpath string(uuid) true Chat ID
200 Response
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/{chat}/tool-results \
-H 'Content-Type: application/json' \
-H 'Coder-Session-Token: API_KEY'
POST /api/v2/chats/{chat}/tool-results
Body parameter
{
"results": [
{
"is_error": true,
"output": [
0
],
"tool_call_id": "string"
}
]
}
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/chats/{chat}/workspace-files \
-H 'Content-Type: */*' \
-H 'Accept: application/json' \
-H 'Content-Disposition: string' \
-H 'Coder-Session-Token: API_KEY' \
--data-binary '@archive.zip'
POST /api/v2/chats/{chat}/workspace-files
Streams the request body into the chat workspace's
upload directory. The request Content-Type header is
recorded as the file's media type. There is no
server-imposed size cap; client cancellation aborts the
stream and the agent leaves no partial target file behind.
Name In Type Required Description chatpath string(uuid) true Chat ID Content-Dispositionheader string true Filename of the file (attachment; filename=...) bodybody string true Raw file binary data
201 Response
{
"media_type": "string",
"name": "string",
"path": "string",
"size": 0,
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/organizations/{organization}/chats/models \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/organizations/{organization}/chats/models
Name In Type Required Description organizationpath string true Organization name or ID
200 Response
{
"models": [
{
"ai_provider_id": "5a3b8ff9-20e7-4c37-ba1a-5b433e355819",
"compression_threshold": 0,
"context_limit": 0,
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"enabled": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_default": true,
"model": "string",
"model_config": {
"frequency_penalty": 0,
"max_output_tokens": 0,
"openai_config": {
"reasoning_model": true,
"use_responses_api": true
},
"presence_penalty": 0,
"provider_options": {
"anthropic": {
"allowed_domains": [
"string"
],
"blocked_domains": [
"string"
],
"context_1m_enabled": true,
"disable_parallel_tool_use": true,
"send_reasoning": true,
"thinking": {
"budget_tokens": 0
},
"thinking_display": "string",
"web_search_enabled": true
},
"google": {
"cached_content": "string",
"safety_settings": [
{
"category": "string",
"threshold": "string"
}
],
"thinking_config": {
"include_thoughts": true,
"thinking_budget": 0,
"thinking_level": "string"
},
"threshold": "string",
"web_search_enabled": true
},
"openai": {
"allowed_domains": [
"string"
],
"include": [
"string"
],
"instructions": "string",
"log_probs": true,
"logit_bias": {
"property1": 0,
"property2": 0
},
"max_completion_tokens": 0,
"max_tool_calls": 0,
"metadata": {
"property1": null,
"property2": null
},
"parallel_tool_calls": true,
"prediction": {
"property1": null,
"property2": null
},
"prompt_cache_key": "string",
"reasoning_mode": "string",
"reasoning_summary": "string",
"safety_identifier": "string",
"search_context_size": "string",
"service_tier": "string",
"store": true,
"strict_json_schema": true,
"structured_outputs": true,
"text_verbosity": "string",
"top_log_probs": 0,
"user": "string",
"web_search_enabled": true
},
"openaicompat": {
"user": "string"
},
"openrouter": {
"extra_body": {
"property1": null,
"property2": null
},
"include_usage": true,
"log_probs": true,
"logit_bias": {
"property1": 0,
"property2": 0
},
"parallel_tool_calls": true,
"provider": {
"allow_fallbacks": true,
"data_collection": "string",
"ignore": [
"string"
],
"only": [
"string"
],
"order": [
"string"
],
"quantizations": [
"string"
],
"require_parameters": true,
"sort": "string"
},
"reasoning": {
"enabled": true,
"exclude": true,
"max_tokens": 0
},
"user": "string"
},
"vercel": {
"extra_body": {
"property1": null,
"property2": null
},
"logit_bias": {
"property1": 0,
"property2": 0
},
"logprobs": true,
"parallel_tool_calls": true,
"providerOptions": {
"models": [
"string"
],
"order": [
"string"
]
},
"reasoning": {
"enabled": true,
"exclude": true,
"max_tokens": 0
},
"top_logprobs": 0,
"user": "string"
}
},
"reasoning_effort": {
"default": "string",
"max": "string"
},
"temperature": 0,
"top_k": 0,
"top_p": 0
},
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"reasoning_efforts": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z"
}
],
"providers": [
{
"allow_user_api_key": true,
"available": true,
"display_name": "string",
"enabled": true,
"has_api_key": true,
"has_effective_api_key": true,
"has_user_api_key": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "string",
"unavailable_reason": "missing_api_key"
}
],
"unsupported_providers": [
{
"display_name": "string",
"provider": "string"
}
]
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/chats/models \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
POST /api/v2/organizations/{organization}/chats/models
Body parameter
{
"ai_provider_id": "5a3b8ff9-20e7-4c37-ba1a-5b433e355819",
"compression_threshold": 0,
"context_limit": 0,
"display_name": "string",
"enabled": true,
"is_default": true,
"model": "string",
"model_config": {
"frequency_penalty": 0,
"max_output_tokens": 0,
"openai_config": {
"reasoning_model": true,
"use_responses_api": true
},
"presence_penalty": 0,
"provider_options": {
"anthropic": {
"allowed_domains": [
"string"
],
"blocked_domains": [
"string"
],
"context_1m_enabled": true,
"disable_parallel_tool_use": true,
"send_reasoning": true,
"thinking": {
"budget_tokens": 0
},
"thinking_display": "string",
"web_search_enabled": true
},
"google": {
"cached_content": "string",
"safety_settings": [
{
"category": "string",
"threshold": "string"
}
],
"thinking_config": {
"include_thoughts": true,
"thinking_budget": 0,
"thinking_level": "string"
},
"threshold": "string",
"web_search_enabled": true
},
"openai": {
"allowed_domains": [
"string"
],
"include": [
"string"
],
"instructions": "string",
"log_probs": true,
"logit_bias": {
"property1": 0,
"property2": 0
},
"max_completion_tokens": 0,
"max_tool_calls": 0,
"metadata": {
"property1": null,
"property2": null
},
"parallel_tool_calls": true,
"prediction": {
"property1": null,
"property2": null
},
"prompt_cache_key": "string",
"reasoning_mode": "string",
"reasoning_summary": "string",
"safety_identifier": "string",
"search_context_size": "string",
"service_tier": "string",
"store": true,
"strict_json_schema": true,
"structured_outputs": true,
"text_verbosity": "string",
"top_log_probs": 0,
"user": "string",
"web_search_enabled": true
},
"openaicompat": {
"user": "string"
},
"openrouter": {
"extra_body": {
"property1": null,
"property2": null
},
"include_usage": true,
"log_probs": true,
"logit_bias": {
"property1": 0,
"property2": 0
},
"parallel_tool_calls": true,
"provider": {
"allow_fallbacks": true,
"data_collection": "string",
"ignore": [
"string"
],
"only": [
"string"
],
"order": [
"string"
],
"quantizations": [
"string"
],
"require_parameters": true,
"sort": "string"
},
"reasoning": {
"enabled": true,
"exclude": true,
"max_tokens": 0
},
"user": "string"
},
"vercel": {
"extra_body": {
"property1": null,
"property2": null
},
"logit_bias": {
"property1": 0,
"property2": 0
},
"logprobs": true,
"parallel_tool_calls": true,
"providerOptions": {
"models": [
"string"
],
"order": [
"string"
]
},
"reasoning": {
"enabled": true,
"exclude": true,
"max_tokens": 0
},
"top_logprobs": 0,
"user": "string"
}
},
"reasoning_effort": {
"default": "string",
"max": "string"
},
"temperature": 0,
"top_k": 0,
"top_p": 0
}
}
201 Response
{
"ai_provider_id": "5a3b8ff9-20e7-4c37-ba1a-5b433e355819",
"compression_threshold": 0,
"context_limit": 0,
"created_at": "2019-08-24T14:15:22Z",
"display_name": "string",
"enabled": true,
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"is_default": true,
"model": "string",
"model_config": {
"frequency_penalty": 0,
"max_output_tokens": 0,
"openai_config": {
"reasoning_model": true,
"use_responses_api": true
},
"presence_penalty": 0,
"provider_options": {
"anthropic": {
"allowed_domains": [
"string"
],
"blocked_domains": [
"string"
],
"context_1m_enabled": true,
"disable_parallel_tool_use": true,
"send_reasoning": true,
"thinking": {
"budget_tokens": 0
},
"thinking_display": "string",
"web_search_enabled": true
},
"google": {
"cached_content": "string",
"safety_settings": [
{
"category": "string",
"threshold": "string"
}
],
"thinking_config": {
"include_thoughts": true,
"thinking_budget": 0,
"thinking_level": "string"
},
"threshold": "string",
"web_search_enabled": true
},
"openai": {
"allowed_domains": [
"string"
],
"include": [
"string"
],
"instructions": "string",
"log_probs": true,
"logit_bias": {
"property1": 0,
"property2": 0
},
"max_completion_tokens": 0,
"max_tool_calls": 0,
"metadata": {
"property1": null,
"property2": null
},
"parallel_tool_calls": true,
"prediction": {
"property1": null,
"property2": null
},
"prompt_cache_key": "string",
"reasoning_mode": "string",
"reasoning_summary": "string",
"safety_identifier": "string",
"search_context_size": "string",
"service_tier": "string",
"store": true,
"strict_json_schema": true,
"structured_outputs": true,
"text_verbosity": "string",
"top_log_probs": 0,
"user": "string",
"web_search_enabled": true
},
"openaicompat": {
"user": "string"
},
"openrouter": {
"extra_body": {
"property1": null,
"property2": null
},
"include_usage": true,
"log_probs": true,
"logit_bias": {
"property1": 0,
"property2": 0
},
"parallel_tool_calls": true,
"provider": {
"allow_fallbacks": true,
"data_collection": "string",
"ignore": [
"string"
],
"only": [
"string"
],
"order": [
"string"
],
"quantizations": [
"string"
],
"require_parameters": true,
"sort": "string"
},
"reasoning": {
"enabled": true,
"exclude": true,
"max_tokens": 0
},
"user": "string"
},
"vercel": {
"extra_body": {
"property1": null,
"property2": null
},
"logit_bias": {
"property1": 0,
"property2": 0
},
"logprobs": true,
"parallel_tool_calls": true,
"providerOptions": {
"models": [
"string"
],
"order": [
"string"
]
},
"reasoning": {
"enabled": true,
"exclude": true,
"max_tokens": 0
},
"top_logprobs": 0,
"user": "string"
}
},
"reasoning_effort": {
"default": "string",
"max": "string"
},
"temperature": 0,
"top_k": 0,
"top_p": 0
},
"organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
"reasoning_efforts": [
"string"
],
"updated_at": "2019-08-24T14:15:22Z"
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X GET http://coder-server:8080/api/v2/users/{user}/ai-provider-keys \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
GET /api/v2/users/{user}/ai-provider-keys
Name In Type Required Description userpath string true User ID, username, or me
200 Response
[
{
"byok_enabled": true,
"has_provider_api_key": true,
"has_user_api_key": true,
"provider": {
"deleted": true,
"display_name": "string",
"enabled": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "openai"
}
}
]
Status Code 200
Name Type Required Restrictions Description [array item]array false » byok_enabledboolean false » has_provider_api_keyboolean false » has_user_api_keyboolean false » providercodersdk.AIProviderSummary false »» deletedboolean false »» display_namestring false »» enabledboolean false »» iconstring false »» idstring(uuid) false »» namestring false »» typecodersdk.AIProviderType false
Property Value(s) typeanthropic, azure, bedrock, copilot, google, openai, openai-compat, openrouter, vercel
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X PUT http://coder-server:8080/api/v2/users/{user}/ai-provider-keys/{aiProvider} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Coder-Session-Token: API_KEY'
PUT /api/v2/users/{user}/ai-provider-keys/{aiProvider}
Body parameter
200 Response
{
"byok_enabled": true,
"has_provider_api_key": true,
"has_user_api_key": true,
"provider": {
"deleted": true,
"display_name": "string",
"enabled": true,
"icon": "string",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"type": "openai"
}
}
To perform this operation, you must be authenticated. Learn more .
# Example request using curl
curl -X DELETE http://coder-server:8080/api/v2/users/{user}/ai-provider-keys/{aiProvider} \
-H 'Coder-Session-Token: API_KEY'
DELETE /api/v2/users/{user}/ai-provider-keys/{aiProvider}
Name In Type Required Description userpath string true User ID, username, or me aiProviderpath string(uuid) true AI provider ID
Status Meaning Description Schema 204 No Content No Content
To perform this operation, you must be authenticated. Learn more .
