{ "info": { "name": "Counso API", "description": "Counso API requests. Set baseUrl and workspaceId, then add your credential locally. Select an individual request and review its path, authentication and body before sending it. API key and user-token requests are grouped separately.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json" }, "variable": [ { "key": "baseUrl", "value": "https://app.counso.ai", "type": "string" }, { "key": "workspaceId", "value": "", "type": "string" } ], "item": [ { "name": "Workspace API", "item": [ { "name": "删除数据表", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables/:tId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables", ":tId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "tId", "value": "", "description": "ID of the table" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "从指定工作区的数据源中删除一张表。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "删除表格行", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables/:tId/rows/:rId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables", ":tId", "rows", ":rId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "tId", "value": "", "description": "ID of the table" }, { "key": "rId", "value": "", "description": "ID of the row" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "从指定工作区的数据源表格中删除一行。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出工作区数据源", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定工作区中的数据源列表。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "写入或更新数据表", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区的数据源中新建表格，或更新已有表格。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"name\": \"{{name}}\",\n \"title\": \"{{title}}\",\n \"table_id\": \"{{table_id}}\",\n \"description\": \"{{description}}\",\n \"timestamp\": 1,\n \"tags\": [\n \"{{tags}}\"\n ],\n \"mime_type\": \"{{mime_type}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "批量写入或更新表格行", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables/:tId/rows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables", ":tId", "rows" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "tId", "value": "", "description": "ID of the table" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区的数据源表格中新增或更新多行。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"rows\": [\n {\n \"row_id\": \"{{row_id}}\",\n \"value\": {}\n }\n ],\n \"truncate\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "搜索数据源", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "search" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" } ], "query": [ { "key": "query", "value": "", "description": "The search query", "disabled": false }, { "key": "top_k", "value": "", "description": "The number of results to return", "disabled": false }, { "key": "full_text", "value": "", "description": "Whether to return the full document content", "disabled": false }, { "key": "target_document_tokens", "value": "", "description": "The number of tokens in the target document", "disabled": true }, { "key": "timestamp_gt", "value": "", "description": "The timestamp to filter by", "disabled": true }, { "key": "timestamp_lt", "value": "", "description": "The timestamp to filter by", "disabled": true }, { "key": "tags_in", "value": "", "description": "The tags to filter by", "disabled": true }, { "key": "tags_not", "value": "", "description": "The tags to filter by", "disabled": true }, { "key": "parents_in", "value": "", "description": "The parents to filter by", "disabled": true }, { "key": "parents_not", "value": "", "description": "The parents to filter by", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区的数据源中搜索内容。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "从数据源读取文档", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "documents", ":documentId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "documentId", "value": "", "description": "ID of the document" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "按数据源 ID 获取指定工作区中的文档。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "写入或更新数据源文档", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "documents", ":documentId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "documentId", "value": "", "description": "ID of the document" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区的数据源中新增文档，或更新已有文档。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"title\": \"{{title}}\",\n \"mime_type\": \"{{mime_type}}\",\n \"text\": \"{{text}}\",\n \"section\": {\n \"prefix\": \"{{prefix}}\",\n \"content\": \"{{content}}\",\n \"sections\": []\n },\n \"source_url\": \"{{source_url}}\",\n \"tags\": [\n \"{{tags}}\"\n ],\n \"timestamp\": 1,\n \"light_document_output\": false,\n \"async\": false,\n \"upsert_context\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取表格行", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables/:tId/rows/:rId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables", ":tId", "rows", ":rId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "tId", "value": "", "description": "ID of the table" }, { "key": "rId", "value": "", "description": "ID of the row" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "读取指定工作区数据源表格中的一行。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出表格行", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables/:tId/rows", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables", ":tId", "rows" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "tId", "value": "", "description": "ID of the table" } ], "query": [ { "key": "limit", "value": "", "description": "Limit the number of rows returned", "disabled": true }, { "key": "offset", "value": "", "description": "Offset the returned rows", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出指定工作区数据源表格中的行。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "获取数据表", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables/:tId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables", ":tId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "tId", "value": "", "description": "ID of the table" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "读取指定工作区数据源中的一张表。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "检查数据源的写入队列状态", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/check_upsert_queue", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "check_upsert_queue" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "查看数据源中正在运行的文档 upsert 工作流数量。此接口仅供系统 API key 使用，例如连接器调用。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出数据源表格", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/tables", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "tables" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定工作区数据源中的表格列表。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "从数据源删除文档", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/documents/:documentId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "documents", ":documentId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "documentId", "value": "", "description": "ID of the document" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "从指定工作区的数据源中删除一份文档。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出数据源文档", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/documents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "documents" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" } ], "query": [ { "key": "document_ids", "value": "", "description": "The IDs of the documents to fetch (optional)", "disabled": true }, { "key": "limit", "value": "", "description": "Limit the number of documents returned", "disabled": true }, { "key": "offset", "value": "", "description": "Offset the returned documents", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定工作区数据源中的文档列表。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "更新文档的父级关系", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_sources/:dsId/documents/:documentId/parents", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_sources", ":dsId", "documents", ":documentId", "parents" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsId", "value": "", "description": "ID of the data source" }, { "key": "documentId", "value": "", "description": "ID of the document" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "更新指定工作区数据源中文档的父级关系。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"parent_id\": \"{{parent_id}}\",\n \"parents\": [\n \"{{parents}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "列出数据源视图", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_source_views", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_source_views" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出指定 Space 中的数据源视图。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "更新数据源视图", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_source_views/:dsvId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "spaceId", "value": "", "description": "" }, { "key": "dsvId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "更新指定 Space 中的数据源视图。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"parentsToAdd\": [\n \"{{parentId}}\"\n ],\n \"parentsToRemove\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "搜索数据源视图", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_source_views/:dsvId/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId", "search" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsvId", "value": "", "description": "ID of the data source view" } ], "query": [ { "key": "query", "value": "", "description": "The search query", "disabled": false }, { "key": "top_k", "value": "", "description": "The number of results to return", "disabled": false }, { "key": "full_text", "value": "", "description": "Whether to return the full document content", "disabled": false }, { "key": "target_document_tokens", "value": "", "description": "The number of tokens in the target document", "disabled": true }, { "key": "timestamp_gt", "value": "", "description": "The timestamp to filter by", "disabled": true }, { "key": "timestamp_lt", "value": "", "description": "The timestamp to filter by", "disabled": true }, { "key": "tags_in", "value": "", "description": "The tags to filter by", "disabled": true }, { "key": "tags_not", "value": "", "description": "The tags to filter by", "disabled": true }, { "key": "parents_in", "value": "", "description": "The parents to filter by", "disabled": true }, { "key": "parents_not", "value": "", "description": "The parents to filter by", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区的数据源视图中搜索内容。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "删除数据源视图", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_source_views/:dsvId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "spaceId", "value": "", "description": "" }, { "key": "dsvId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "从指定 Space 中删除指定的数据源视图。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "获取数据源视图", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/data_source_views/:dsvId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "spaceId", "value": "", "description": "" }, { "key": "dsvId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "读取指定 Space 中数据源视图的详情。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出可用 MCP 服务器视图", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/mcp_server_views", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "mcp_server_views" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出当前已认证工作区指定 Space 中已启用的 MCP 服务器视图（即工具）。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "获取触发器", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/triggers/:tId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "triggers", ":tId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "tId", "value": "", "description": "ID of the trigger" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "使用工作区管理员 API key，按 ID 获取一个定时运行或 Webhook 触发器。\n\n在 `Authorization: Bearer ` 中传入工作区管理员 API key。" }, "response": [] }, { "name": "列出触发器", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/triggers", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "triggers" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "kind", "value": "", "description": "Filter by trigger kind", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of triggers to return (default 50, max 100)", "disabled": true }, { "key": "offset", "value": "", "description": "Number of triggers to skip, for pagination", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出工作区中配置的智能体触发器，包括定时运行和 Webhook。需要使用工作区管理员 API key。\n\n在 `Authorization: Bearer ` 中传入工作区管理员 API key。" }, "response": [] }, { "name": "列出可访问的 Space", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" } ], "query": [ { "key": "kinds", "value": "", "description": "Comma-separated list of space kinds to filter on, among `system`, `global`, `regular` and `project`. Defaults to `system,global,regular` — projects must be requested explicitly.", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出当前已认证工作区中用户可访问的 Space。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "导入智能体配置", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations/import", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations", "import" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "根据符合智能体配置 schema 的 JSON 正文创建新的智能体配置。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"agent\": {\n \"handle\": \"{{handle}}\",\n \"description\": \"{{description}}\",\n \"scope\": \"visible\",\n \"avatar_url\": \"{{avatar_url}}\",\n \"max_steps_per_run\": 1,\n \"visualization_enabled\": false\n },\n \"instructions\": \"{{instructions}}\",\n \"generation_settings\": {\n \"model_id\": \"{{model_id}}\",\n \"provider_id\": \"{{provider_id}}\",\n \"temperature\": 1,\n \"reasoning_effort\": \"{{reasoning_effort}}\"\n },\n \"tags\": [\n {\n \"name\": \"{{name}}\",\n \"kind\": \"standard\"\n }\n ],\n \"editors\": [\n \"alice@example.com\"\n ],\n \"toolset\": [\n {\n \"name\": \"{{name}}\",\n \"description\": \"{{description}}\",\n \"type\": \"MCP\",\n \"configuration\": {}\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "按名称搜索智能体", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations", "search" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "q", "value": "", "description": "Search query for agent configuration names", "disabled": false } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "按名称搜索指定工作区中的智能体配置。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出智能体配置", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "view", "value": "", "description": "The view to use when retrieving agents:\n- all: Retrieves all non-private agents (default if not authenticated)\n- list: Retrieves all active agents accessible to the user (default if authenticated)\n- published: Retrieves all agents with published scope\n- global: Retrieves all global agents\n- favorites: Retrieves all agents marked as favorites by the user (only available to authenticated users)\n- all_unrestricted: Retrieves every active agent of the workspace, including unpublished agents the caller does not edit and agents requesting spaces the caller cannot access. Requires an admin key.\n", "disabled": true }, { "key": "withAuthors", "value": "", "description": "When set to 'true', includes recent authors information for each agent", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出指定工作区中的智能体配置。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "获取智能体配置", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations/:sId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations", ":sId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "sId", "value": "", "description": "ID of the agent configuration" } ], "query": [ { "key": "variant", "value": "light", "description": "Configuration variant to retrieve. 'light' returns basic config without actions, 'full' includes complete actions/tools configuration", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "按配置 ID 获取指定工作区中的智能体配置。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "归档智能体配置", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations/:sId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations", ":sId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "sId", "value": "", "description": "ID of the agent configuration" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "将指定工作区中的智能体配置软归档，并停用它的触发器。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "以 YAML 导出智能体配置", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations/:sId/export/yaml", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations", ":sId", "export", "yaml" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "sId", "value": "", "description": "ID of the agent configuration" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "下载指定的智能体配置，并以 YAML 文件返回。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "更新智能体配置", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/agent_configurations/:sId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "agent_configurations", ":sId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "sId", "value": "", "description": "ID of the agent configuration" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "更新指定工作区中的智能体配置。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"userFavorite\": false,\n \"agent\": {\n \"handle\": \"{{handle}}\",\n \"description\": \"{{description}}\",\n \"scope\": \"visible\",\n \"avatar_url\": \"{{avatar_url}}\",\n \"max_steps_per_run\": 1,\n \"visualization_enabled\": false\n },\n \"instructions\": \"{{instructions}}\",\n \"generation_settings\": {\n \"model_id\": \"{{model_id}}\",\n \"provider_id\": \"{{provider_id}}\",\n \"temperature\": 1,\n \"reasoning_effort\": \"{{reasoning_effort}}\"\n },\n \"tags\": [\n {\n \"name\": \"{{name}}\",\n \"kind\": \"standard\"\n }\n ],\n \"editors\": [\n \"alice@example.com\"\n ],\n \"skills\": [\n {\n \"sId\": \"{{sId}}\",\n \"name\": \"{{name}}\"\n }\n ],\n \"toolset\": [\n {\n \"name\": \"{{name}}\",\n \"description\": \"{{description}}\",\n \"type\": \"MCP\",\n \"configuration\": {\n \"mcp_server_name\": \"{{mcp_server_name}}\"\n }\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取提及建议", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/mentions/suggestions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "mentions", "suggestions" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "query", "value": "", "description": "Search query string to filter suggestions", "disabled": false }, { "key": "select", "value": "", "description": "Array of mention types to include. Can be \"agents\", \"users\", or both. If not provided, defaults to agents and users.", "disabled": true }, { "key": "current", "value": "", "description": "Whether to include the current user in the suggestions.", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "根据搜索词获取可用的智能体和用户提及建议。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "解析 Markdown 中的提及", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/mentions/parse", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "mentions", "parse" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "解析粘贴文本中的 @ 提及，并转换为系统可识别的提及格式。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"markdown\": \"Hello @JohnDoe, can you help with @MyAgent?\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取对话中的提及建议", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/mentions/suggestions", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "mentions", "suggestions" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ], "query": [ { "key": "query", "value": "", "description": "Search query string to filter suggestions", "disabled": false }, { "key": "select", "value": "", "description": "Array of mention types to include. Can be \"agents\", \"users\", or both. If not provided, defaults to agents and users.", "disabled": true }, { "key": "current", "value": "", "description": "Whether to include the current user in the suggestions.", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "根据搜索词获取指定对话可用的智能体和用户提及建议。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "上传工具文件", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/search/tools/upload", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "search", "tools", "upload" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "将 MCP 服务器工具返回的文件下载后上传到工作区。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"serverViewId\": \"{{serverViewId}}\",\n \"externalId\": \"{{externalId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "搜索工作区节点", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "search" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在工作区中搜索内容节点。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"query\": \"{{query}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "流式搜索工作区节点", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/search", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "search" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "query", "value": "", "description": "The search query (minimum 3 characters)", "disabled": false }, { "key": "limit", "value": "", "description": "Number of results per page (1-100, default 25)", "disabled": true }, { "key": "cursor", "value": "", "description": "Cursor for pagination", "disabled": true }, { "key": "viewType", "value": "", "description": "Type of view to filter results", "disabled": true }, { "key": "spaceIds", "value": "", "description": "Comma-separated list of space IDs to search in", "disabled": true }, { "key": "includeDataSources", "value": "", "description": "Whether to include data sources", "disabled": true }, { "key": "searchSourceUrls", "value": "", "description": "Whether to search source URLs", "disabled": true }, { "key": "includeTools", "value": "", "description": "Whether to include tool results", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在工作区搜索节点，并通过 SSE 流式返回结果。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "审核对话消息中的操作", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages/:mId/validate-action", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "validate-action" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" }, { "key": "mId", "value": "", "description": "Message ID" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "批准或拒绝对话中某条消息执行的操作。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"{{actionId}}\",\n \"approved\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "编辑对话中的现有消息", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages/:mId/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "edit" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" }, { "key": "mId", "value": "", "description": "Message ID to edit" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "编辑指定对话中的现有消息内容。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"content\": \"{{content}}\",\n \"mentions\": [\n {\n \"configurationId\": \"{{configurationId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "更新对话", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "更新指定工作区中对话的标题，或将其标记为已读、未读。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"read\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取对话", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ], "query": [ { "key": "limit", "value": "", "description": "Maximum number of messages to return. When omitted, all messages are returned.", "disabled": true }, { "key": "lastValue", "value": "", "description": "Cursor value (message rank) from a previous response to fetch the next page of messages.", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定工作区中的对话；可用 limit 和 lastValue 查询参数分页读取消息。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "取消对话中的消息生成", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "cancel" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "停止指定对话中正在进行的消息生成。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"messageIds\": [\n \"{{messageIds}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取消息事件", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages/:mId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "events" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ], "query": [ { "key": "lastEventId", "value": "", "description": "ID of the last event received", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定工作区中某条消息关联的事件。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "获取对话事件", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "events" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ], "query": [ { "key": "lastEventId", "value": "", "description": "ID of the last event", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定工作区中某个对话的事件。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "创建新对话", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区中创建一个新对话。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"message\": {\n \"content\": \"This is my message\",\n \"mentions\": [\n {\n \"configurationId\": \"7f3a9c2b1e\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "回答对话消息中的用户问题", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages/:mId/answer-question", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "answer-question" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" }, { "key": "mId", "value": "", "description": "Message ID" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "提交对话中某条消息所含问题的答案。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"{{actionId}}\",\n \"answer\": {\n \"selectedOptions\": [\n 1\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "按路径下载对话文件", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/files/:rel", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "files", ":rel" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "rel", "value": "", "description": "Conversation-scoped file path: the canonical `filePath` returned in a message\naction's `generatedFiles`, or the legacy `conversation/foo.pdf` form. Paths\nscoped to another conversation or to a different scope are rejected. Path\ntraversal segments (`..`) are rejected.\n" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "使用对话内的文件路径流式下载文件。优先使用消息操作 generatedFiles 返回的规范 filePath，也支持旧版 conversation/foo.pdf 形式。属于其他对话或其他范围的路径，以及包含 .. 越界片段的路径，都会被拒绝。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "创建对话消息", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区和对话中创建一条消息。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"content\": \"This is my message\",\n \"mentions\": [\n {\n \"configurationId\": \"7f3a9c2b1e\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "创建文件上传地址", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "files" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "为工作区文件创建上传记录并取得上传所需的 URL。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"{{contentType}}\",\n \"fileName\": \"{{fileName}}\",\n \"fileSize\": 1,\n \"useCase\": \"{{useCase}}\",\n \"useCaseMetadata\": \"{{useCaseMetadata}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "创建内容片段", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/content_fragments", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "content_fragments" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定工作区的对话中创建新的内容片段。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"title\": \"My content fragment\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取对话反馈", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/feedbacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "feedbacks" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定对话中的全部反馈记录。调用方须完成身份验证，并具备 read:conversation 权限。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "提交消息反馈", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages/:mId/feedbacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "feedbacks" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" }, { "key": "mId", "value": "", "description": "Message ID" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "为对话中的指定消息提交赞或踩的反馈。调用方须完成身份验证，并具备 update:conversation 权限。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"thumbDirection\": \"up\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "删除消息反馈", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/assistant/conversations/:cId/messages/:mId/feedbacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "feedbacks" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "cId", "value": "", "description": "Conversation ID" }, { "key": "mId", "value": "", "description": "Message ID" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "删除用户对指定对话消息提交的反馈。调用方须完成身份验证，并具备 update:conversation 权限。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出 Skills", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/skills", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "skills" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" } ], "query": [ { "key": "status", "value": "", "description": "Filter skills by status. Defaults to active.", "disabled": true }, { "key": "availability", "value": "", "description": "Filter skills by availability. Repeatable to match several values. Unpublished (editors) skills are only returned when bypassEditorVisibility is set.", "disabled": true }, { "key": "bypassEditorVisibility", "value": "", "description": "When true, also return unpublished (editors) skills. Requires an admin API key.", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出工作区中的自定义 Skills；默认仅返回启用中的 Skills。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "从上传文件导入 Skills", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/skills", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "skills" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "从已上传的文件或 ZIP 压缩包导入 Skills。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "formdata", "formdata": [ { "key": "files", "type": "file", "description": "Repeat this field for each value." }, { "key": "names", "type": "text", "value": "", "description": "Repeat this field for each value." }, { "key": "onConflict", "type": "text", "value": "" }, { "key": "editors", "type": "text", "value": "", "description": "Repeat this field for each value." }, { "key": "availability", "type": "text", "value": "" } ] } }, "response": [] }, { "name": "归档 Skill", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/skills/:skillId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "skills", ":skillId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "skillId", "value": "", "description": "Unique string identifier for the custom skill" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "软归档工作区中的自定义 Skill。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "列出 Space 中的应用", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/apps", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "apps" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "列出指定 Space 中的所有应用。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "获取应用运行记录", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/apps/:aId/runs/:runId", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "apps", ":aId", "runs", ":runId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "aId", "value": "", "description": "ID of the app" }, { "key": "runId", "value": "", "description": "ID of the run" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "获取指定 Space 中某个应用运行的结果。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] }, { "name": "创建并运行应用", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/spaces/:spaceId/apps/:aId/runs", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "spaces", ":spaceId", "apps", ":aId", "runs" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "aId", "value": "", "description": "Unique identifier of the app" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "在指定 Space 中创建应用运行并执行。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。", "body": { "mode": "raw", "raw": "{\n \"specification_hash\": \"{{specification_hash}}\",\n \"config\": {\n \"model\": {\n \"provider_id\": \"{{provider_id}}\",\n \"model_id\": \"{{model_id}}\",\n \"use_cache\": false,\n \"use_stream\": false\n }\n },\n \"inputs\": [\n {}\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "导出工作区分析数据", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/analytics/export", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "analytics", "export" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Unique string identifier for the workspace" } ], "query": [ { "key": "table", "value": "", "description": "The analytics table to export:\n- \"usage_metrics\": Messages, conversations, and active users over time.\n- \"active_users\": Daily, weekly, and monthly active user counts.\n- \"source\": Message volume by context origin (web, slack, etc.).\n- \"agents\": Top agents by message count, including credits.\n- \"users\": Top users by message count, including credits, last login date and membership status (active, revoked, unregistered).\n- \"skills\": Skill metadata catalog.\n- \"skill_usage\": Skill executions and unique users over time.\n- \"tool_usage\": Tool executions and unique users over time.\n- \"messages\": Detailed message-level logs, including comma-separated lists of tools (as \"server__tool\") and skills used per message, and the cost in credits of each message.\n- \"feedback\": Detailed message-level feedback (thumbs, content, conversation URL).\n", "disabled": false }, { "key": "startDate", "value": "", "description": "Start date in YYYY-MM-DD format", "disabled": false }, { "key": "endDate", "value": "", "description": "End date in YYYY-MM-DD format", "disabled": false }, { "key": "timezone", "value": "", "description": "IANA timezone name (defaults to UTC)", "disabled": true }, { "key": "format", "value": "", "description": "Output format (defaults to csv)", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "description": "将指定工作区的分析数据导出为 CSV 或 JSON。\n\n在 `Authorization: Bearer ` 中传入工作区 API key 或用户 OAuth access token。凭据须由当前 Counso 环境签发，并有权访问目标工作区与资源。" }, "response": [] } ] }, { "name": "Sign-in flow", "item": [ { "name": "兑换授权码或刷新令牌", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/workos/authenticate", "host": [ "{{baseUrl}}" ], "path": [ "api", "workos", "authenticate" ] }, "auth": { "type": "noauth" }, "description": "在登录或续期流程中，将 WorkOS 授权码或刷新令牌换成用户访问令牌，不要求已有的 Bearer token。\n\n可提交授权码及对应的 PKCE verifier，或提交 grant_type=refresh_token 和 refresh token 来刷新会话。无需已有的 Bearer token；支持 JSON 与表单编码请求体。", "body": { "mode": "raw", "raw": "{\n \"code\": \"{{authorizationCode}}\",\n \"code_verifier\": \"{{codeVerifier}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "撤销登录会话", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/workos/revoke-session", "host": [ "{{baseUrl}}" ], "path": [ "api", "workos", "revoke-session" ] }, "auth": { "type": "noauth" }, "description": "按 session_id 撤销对应的 WorkOS 会话，使该会话退出登录。此接口不要求 Bearer token。\n\n提交要撤销的 session_id，以结束该用户会话。此退出登录接口不要求 Bearer token。", "body": { "mode": "raw", "raw": "{\n \"session_id\": \"{{session_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "发起 WorkOS 登录", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/workos/login", "host": [ "{{baseUrl}}" ], "path": [ "api", "workos", "login" ], "query": [ { "key": "redirect_uri", "value": "", "description": "Custom redirect URI (used by extensions for PKCE flow)", "disabled": true }, { "key": "code_challenge", "value": "", "description": "PKCE code challenge", "disabled": true }, { "key": "code_challenge_method", "value": "", "description": "PKCE code challenge method (S256)", "disabled": true } ] }, "auth": { "type": "noauth" }, "description": "通过重定向到 WorkOS AuthKit 开始用户登录。客户端可以传入 PKCE 参数，不要求已有的 Bearer token。\n\n此接口用于开始用户登录，不要求已有的 Bearer token。使用 PKCE 的客户端提交已登记的回调地址与 code challenge，响应会将用户重定向至身份服务。" }, "response": [] } ] }, { "name": "User session API", "item": [ { "name": "列出用量分析筛选值", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/analytics/consumption/facets", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "analytics", "consumption", "facets" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "此会话接口返回所选期间各用量维度中的当前实体与历史索引值。应用其他筛选条件后，若某维度没有匹配的索引文档，该维度会被禁用。工作区路径要求 Manager 权限；/me 路径仅限当前登录成员；智能体路径则允许工作区 Manager 或所选智能体的编辑者访问。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"period\": \"cycle\",\n \"days\": 30,\n \"scope\": \"all\",\n \"dimensions\": [\n \"agent\"\n ],\n \"filter\": {\n \"agents\": [\n \"{{agents}}\"\n ],\n \"users\": [\n \"{{users}}\"\n ],\n \"api_keys\": [\n \"{{api_keys}}\"\n ],\n \"groups\": [\n \"{{groups}}\"\n ],\n \"models\": [\n \"{{models}}\"\n ],\n \"tools\": [\n \"{{tools}}\"\n ],\n \"skills\": [\n \"{{skills}}\"\n ],\n \"sources\": [\n \"{{sources}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "取消定时唤醒", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/wakeups/:wuId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "wakeups", ":wuId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "wuId", "value": "", "description": "sId of the wake-up to cancel" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：取消已安排的 wake-up；仅创建该 wake-up 的用户或工作区管理员可以操作。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取对话参与者", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "participants" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出指定对话的参与者。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "更新对话", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：更新对话标题、已读状态、所属 Space，或控制 URL 访问模式。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"title\": \"{{title}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "删除或退出对话", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：删除对话；如果对话已共享，则可退出而不删除其他参与者的对话。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "取消消息生成", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/cancel", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "cancel" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：取消对话中正在生成的消息。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"action\": \"cancel\",\n \"messageIds\": [\n \"{{messageIds}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取对话详情", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：按对话 ID 读取指定对话。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "添加对话参与者", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/participants", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "participants" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：将当前已认证用户加入指定对话。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "列出当前用户的对话", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：分页列出当前已认证用户在工作区中的对话。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "列出可选 Space", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/selectable_spaces", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "selectable_spaces" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "cId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出当前用户可为对话选择的常规 Space，并返回当前选择状态。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "创建对话", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：创建对话，可同时附带首条用户消息和内容片段。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"title\": \"{{title}}\",\n \"visibility\": \"unlisted\",\n \"spaceId\": \"{{spaceId}}\",\n \"message\": {\n \"content\": \"{{content}}\",\n \"mentions\": [\n {\n \"configurationId\": \"{{configurationId}}\",\n \"type\": \"user\",\n \"userId\": \"{{userId}}\"\n }\n ],\n \"context\": {\n \"timezone\": \"{{timezone}}\",\n \"profilePictureUrl\": \"{{profilePictureUrl}}\",\n \"origin\": \"{{origin}}\",\n \"clientSideMCPServerIds\": [\n \"{{clientSideMCPServerIds}}\"\n ],\n \"selectedMCPServerViewIds\": [\n \"{{selectedMCPServerViewIds}}\"\n ],\n \"selectedSpaceIds\": [\n \"{{selectedSpaceIds}}\"\n ]\n }\n },\n \"contentFragments\": [\n {}\n ],\n \"metadata\": {\n \"useDatabaseFileSystem\": false\n },\n \"selectedSpaceIds\": [\n \"{{selectedSpaceIds}}\"\n ],\n \"skipToolsValidation\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取当前用户提交的对话反馈", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/feedbacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "feedbacks" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：读取当前已认证用户为指定对话提交的全部反馈。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "列出对话的定时唤醒", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/wakeups", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "wakeups" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出对话中安排的全部 wake-up，包括各种状态。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "为对话选择 Space", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/selected_spaces", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "selected_spaces" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "cId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：将常规 Space 追加到对话明确选择的数据范围中。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"mode\": \"add\",\n \"spaceIds\": [\n \"{{spaceIds}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "压缩对话上下文", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/compactions", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "compactions" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：总结较早的对话消息并写入压缩摘要；需要指定用于生成摘要的模型。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"model\": {\n \"providerId\": \"{{providerId}}\",\n \"modelId\": \"{{modelId}}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取对话的 credits 归因", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/consumption", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "consumption" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "cId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：返回该对话已完成消息的最新稳定计费 credits，以及仅根据模型输入行核算的补充归因；运行中的消息结束后纳入统计。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "创建对话内容片段", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/content_fragment", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "content_fragment" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：向现有对话添加一个新的内容片段。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"title\": \"{{title}}\",\n \"content\": \"{{content}}\",\n \"contentType\": \"{{contentType}}\",\n \"context\": {\n \"profilePictureUrl\": \"{{profilePictureUrl}}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "实时接收对话事件", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "events" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：通过 SSE 实时接收对话事件；SSE 流量会转发到 /api/sse/。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "实时接收 Pod 函数调用事件", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/sandbox-functions/:functionId/invocations/:invocationId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "sandbox-functions", ":functionId", "invocations", ":invocationId", "events" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "functionId", "value": "", "description": "ID of the Pod function" }, { "key": "invocationId", "value": "", "description": "ID of the sandbox function invocation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：通过 SSE 实时接收 Pod 函数调用事件，流量会转发到 /api/sse/。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "实时接收消息事件", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/events", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "events" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：通过 SSE 实时接收指定智能体消息的事件；仅适用于智能体消息，流量会转发到 /api/sse/。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "创建文件上传记录", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/files", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "files" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：创建文件记录并返回预签名上传 URL；随后需将文件内容上传到该地址。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"{{contentType}}\",\n \"fileName\": \"{{fileName}}\",\n \"fileSize\": 1,\n \"useCase\": \"conversation\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "查看或下载文件", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "files", ":fileId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "fileId", "value": "", "description": "ID of the file" } ], "query": [ { "key": "version", "value": "", "description": "File version to retrieve", "disabled": true }, { "key": "action", "value": "", "description": "Action to perform", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：查看或下载文件；读取 Skill 附件需要对关联 Skill 有读取权限。可用 version 参数选择 original、processed 或 public 版本，并用 action 指定 view 或 download。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "删除文件", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "files", ":fileId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "fileId", "value": "", "description": "ID of the file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：从工作区删除文件；被 Skill 或其版本历史引用的文件不能删除。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "上传文件内容", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/files/:fileId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "files", ":fileId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "fileId", "value": "", "description": "ID of the file" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：处理并保存已上传的文件内容。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file" } ] } }, "response": [] }, { "name": "获取工作区提及建议", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/mentions/suggestions", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "mentions", "suggestions" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "query", "value": "", "description": "Search query to filter suggestions", "disabled": true }, { "key": "select", "value": "", "description": "Filter by type (agents, users, or both)", "disabled": true }, { "key": "current", "value": "", "description": "Whether to include only current mentions", "disabled": true }, { "key": "spaceId", "value": "", "description": "Filter suggestions by space", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：获取工作区范围内可用的提及建议。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取工作区功能开关", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/feature-flags", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "feature-flags" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出当前工作区已启用的功能开关。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "更新当前用户资料", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：更新当前已认证用户的资料，包括姓名、job type、常用平台和头像。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"{{firstName}}\",\n \"lastName\": \"{{lastName}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取当前用户", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/user", "host": [ "{{baseUrl}}" ], "path": [ "api", "user" ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：读取当前已认证用户及其工作区和 subscriber hash。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "重试智能体消息", "request": { "method": "POST", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/retry", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "retry" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：重新生成智能体回复，也可只重试被阻止的操作。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取智能体消息的 credits 归因", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/consumption", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "consumption" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "cId", "value": "", "description": "" }, { "key": "mId", "value": "", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：返回智能体消息的直接和总计费 credits；run-agent 工具行包含调用成本及其子智能体树的费用。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "提交消息反馈", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/feedbacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "feedbacks" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：创建或更新对指定智能体消息的赞成或反对反馈。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"thumbDirection\": \"up\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "删除消息反馈", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/feedbacks", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "feedbacks" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：移除当前用户对指定智能体消息提交的反馈。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取消息", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：按消息 ID 读取对话中的指定消息。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "向对话发送消息", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：向现有对话发送新的用户消息并触发智能体回复。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"content\": \"{{content}}\",\n \"context\": {\n \"timezone\": \"{{timezone}}\",\n \"profilePictureUrl\": \"{{profilePictureUrl}}\",\n \"origin\": \"{{origin}}\",\n \"clientSideMCPServerIds\": [\n \"{{clientSideMCPServerIds}}\"\n ],\n \"selectedMCPServerViewIds\": [\n \"{{selectedMCPServerViewIds}}\"\n ],\n \"selectedSpaceIds\": [\n \"{{selectedSpaceIds}}\"\n ]\n },\n \"mentions\": [\n {\n \"configurationId\": \"{{configurationId}}\",\n \"type\": \"user\",\n \"userId\": \"{{userId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取单项操作", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/actions/:aId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "actions", ":aId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" }, { "key": "aId", "value": "", "description": "ID of the action" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：按操作 ID 获取智能体消息中的单项操作及其消息状态。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "列出对话消息", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：分页读取指定对话中的消息。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "删除消息", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：软删除对话中的用户消息或智能体消息。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "编辑消息", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/conversations/:cId/messages/:mId/edit", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "conversations", ":cId", "messages", ":mId", "edit" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "cId", "value": "", "description": "ID of the conversation" }, { "key": "mId", "value": "", "description": "ID of the message" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：编辑对话中现有用户消息的正文和提及对象。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"content\": \"{{content}}\",\n \"mentions\": [\n {\n \"configurationId\": \"{{configurationId}}\",\n \"type\": \"user\",\n \"userId\": \"{{userId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "生成对话模板草稿", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/go-template", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "go-template" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "slug", "value": "", "description": "Contentful template slug", "disabled": false } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：按 slug 获取 Contentful 对话模板，并返回可直接用于撰写消息的草稿，可包含预先上传的附件。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "删除 Space", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ], "query": [ { "key": "force", "value": "", "description": "Force deletion even if space is in use", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：从工作区删除指定 Space。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "创建 Space", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：在工作区中创建 Space。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"isRestricted\": false,\n \"name\": \"{{name}}\",\n \"spaceKind\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "列出数据源视图", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/data_source_views", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "data_source_views" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ], "query": [ { "key": "category", "value": "", "description": "Filter by data source view category", "disabled": true }, { "key": "withDetails", "value": "", "description": "Include usage and connector details (requires category)", "disabled": true }, { "key": "includeEditedBy", "value": "", "description": "Include editedByUser information", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出指定 Space 中的全部数据源视图。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "创建数据源视图", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/data_source_views", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "data_source_views" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：在指定 Space 中创建数据源视图。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"dataSourceId\": \"{{dataSourceId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "更新 Space", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：更新指定 Space 的属性。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"name\": \"{{name}}\",\n \"content\": [\n {\n \"dataSourceId\": \"{{dataSourceId}}\",\n \"parentsIn\": [\n \"{{parentsIn}}\"\n ]\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "列出工作区 Space", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "role", "value": "", "description": "Filter by role (e.g. admin to list all workspace spaces)", "disabled": true }, { "key": "kind", "value": "", "description": "Filter by one or more space kinds. Repeat the parameter to include several kinds.", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出当前工作区中的 Space。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "更新数据源视图", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/data_source_views/:dsvId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsvId", "value": "", "description": "ID of the data source view" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：更新指定数据源视图。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"parentsIn\": [\n \"{{parentsIn}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "设置项目 Space 通知偏好", "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/project_notification_preferences", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "project_notification_preferences" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the project space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：设置当前用户对项目 Space 的通知偏好。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"preference\": \"all_messages\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "获取项目 Space 通知偏好", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/project_notification_preferences", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "project_notification_preferences" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the project space" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：读取当前用户对项目 Space 设置的通知偏好。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取 Space 详情", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" } ], "query": [ { "key": "includeAllMembers", "value": "", "description": "Include all members (including inactive)", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：读取指定 Space 的详情，包括分类、成员和权限。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "删除数据源视图", "request": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/data_source_views/:dsvId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsvId", "value": "", "description": "ID of the data source view" } ], "query": [ { "key": "force", "value": "", "description": "Force deletion even if the view is in use", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：删除指定的数据源视图。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取数据源视图", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/spaces/:spaceId/data_source_views/:dsvId", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "spaces", ":spaceId", "data_source_views", ":dsvId" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" }, { "key": "spaceId", "value": "", "description": "ID of the space" }, { "key": "dsvId", "value": "", "description": "ID of the data source view" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：读取指定数据源视图的详情。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "创建智能体配置", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/agent_configurations", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "agent_configurations" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：在工作区中创建新的智能体配置。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"assistant\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "列出智能体配置", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/agent_configurations", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "agent_configurations" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "view", "value": "", "description": "Filter agents by view", "disabled": true }, { "key": "limit", "value": "", "description": "Maximum number of results to return", "disabled": true }, { "key": "withUsage", "value": "", "description": "Include usage statistics", "disabled": true }, { "key": "withAuthors", "value": "", "description": "Include recent authors", "disabled": true }, { "key": "withFeedbacks", "value": "", "description": "Include feedback counts", "disabled": true }, { "key": "withEditors", "value": "", "description": "Include editors list", "disabled": true }, { "key": "sort", "value": "", "description": "Sort order", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：列出当前用户可访问的工作区智能体配置。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "获取扩展配置", "request": { "method": "GET", "header": [], "url": { "raw": "{{baseUrl}}/api/w/:wId/extension/config", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "extension", "config" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "会话接口：读取工作区的扩展配置，包括被禁止访问的域名。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。" }, "response": [] }, { "name": "列出个人用量筛选项", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/me/analytics/consumption/facets", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "me", "analytics", "consumption", "facets" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "返回所选期间内当前登录成员可用的用量筛选值。服务器将范围限定为该成员，不返回用户和群组维度；其他维度上的筛选条件会影响可选值。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"period\": \"cycle\",\n \"days\": 30,\n \"scope\": \"all\",\n \"dimensions\": [\n \"agent\"\n ],\n \"filter\": {\n \"agents\": [\n \"{{agents}}\"\n ],\n \"users\": [\n \"{{users}}\"\n ],\n \"api_keys\": [\n \"{{api_keys}}\"\n ],\n \"groups\": [\n \"{{groups}}\"\n ],\n \"models\": [\n \"{{models}}\"\n ],\n \"tools\": [\n \"{{tools}}\"\n ],\n \"skills\": [\n \"{{skills}}\"\n ],\n \"sources\": [\n \"{{sources}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "列出智能体用量筛选项", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/w/:wId/assistant/agent_configurations/:aId/analytics/consumption/facets", "host": [ "{{baseUrl}}" ], "path": [ "api", "w", ":wId", "assistant", "agent_configurations", ":aId", "analytics", "consumption", "facets" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "" }, { "key": "aId", "value": "", "description": "ID of the agent configuration" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "返回指定智能体在所选期间内可用的用量筛选值。工作区 Manager 和该智能体的编辑者可以调用此接口。结果不包含智能体维度，其他可选值取决于已应用的筛选条件。\n\n此接口需要用户身份：外部客户端通过 `Authorization: Bearer ` 传入用户 OAuth access token；已登录的浏览器也可使用 Counso 会话 Cookie。工作区 API key 不能代替用户身份。", "body": { "mode": "raw", "raw": "{\n \"period\": \"cycle\",\n \"days\": 30,\n \"scope\": \"all\",\n \"dimensions\": [\n \"agent\"\n ],\n \"filter\": {\n \"agents\": [\n \"{{agents}}\"\n ],\n \"users\": [\n \"{{users}}\"\n ],\n \"api_keys\": [\n \"{{api_keys}}\"\n ],\n \"groups\": [\n \"{{groups}}\"\n ],\n \"models\": [\n \"{{models}}\"\n ],\n \"tools\": [\n \"{{tools}}\"\n ],\n \"skills\": [\n \"{{skills}}\"\n ],\n \"sources\": [\n \"{{sources}}\"\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Webhook receiver", "item": [ { "name": "接收用于触发流程的外部 Webhook", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/triggers/hooks/:webhookSourceId/:webhookSourceUrlSecret", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "triggers", "hooks", ":webhookSourceId", ":webhookSourceUrlSecret" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "Workspace ID" }, { "key": "webhookSourceId", "value": "", "description": "Webhook source ID" }, { "key": "webhookSourceUrlSecret", "value": "", "description": "Secret included in the generated webhook URL" } ] }, "auth": { "type": "noauth" }, "description": "接收发往该来源专属 Webhook URL 的 JSON 事件。URL 中包含 secret；若该来源配置了签名校验，请求必须携带基于原始请求正文生成的有效签名，事件才会被接收。\n\n使用该来源生成的完整 Webhook URL，保留其中的密钥路径。此接口不使用 API key。若已配置签名校验，请使用对应请求头，并对实际发送的原始请求体计算签名。不要公开生成的 Webhook URL。", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Client-side MCP · user OAuth", "item": [ { "name": "注册客户端 MCP 服务器", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/mcp/register", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "mcp", "register" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "为当前用户和工作区注册客户端 MCP 服务器，并返回新生成的 serverId。\n\n在 `Authorization: Bearer ` 中传入用户 OAuth access token。客户端 MCP 的注册与通信接口不接受工作区 API key。", "body": { "mode": "raw", "raw": "{\n \"serverName\": \"{{serverName}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "更新客户端 MCP 服务器心跳", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/mcp/heartbeat", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "mcp", "heartbeat" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "更新已注册客户端 MCP 服务器的心跳，以延长注册有效期。\n\n在 `Authorization: Bearer ` 中传入用户 OAuth access token。客户端 MCP 的注册与通信接口不接受工作区 API key。", "body": { "mode": "raw", "raw": "{\n \"serverId\": \"{{serverId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "接收工作区 MCP 工具请求流", "request": { "method": "GET", "header": [ { "key": "Accept", "value": "text/event-stream" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/mcp/requests", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "mcp", "requests" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ], "query": [ { "key": "serverId", "value": "", "description": "ID of the MCP server to filter events for", "disabled": false }, { "key": "lastEventId", "value": "", "description": "ID of the last event to filter events for", "disabled": true } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "通过 SSE 长连接实时接收工作区发给客户端 MCP 服务器的工具请求。\n\n在 `Authorization: Bearer ` 中传入用户 OAuth access token。客户端 MCP 的注册与通信接口不接受工作区 API key。" }, "response": [] }, { "name": "提交 MCP 工具执行结果", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/mcp/results", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "mcp", "results" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "将客户端 MCP 服务器在本地执行的工具结果提交回来。\n\n在 `Authorization: Bearer ` 中传入用户 OAuth access token。客户端 MCP 的注册与通信接口不接受工作区 API key。", "body": { "mode": "raw", "raw": "{\n \"result\": {},\n \"serverId\": \"{{serverId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "注销客户端 MCP 服务器", "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/api/v1/w/:wId/mcp/deregister", "host": [ "{{baseUrl}}" ], "path": [ "api", "v1", "w", ":wId", "mcp", "deregister" ], "variable": [ { "key": "wId", "value": "{{workspaceId}}", "description": "ID of the workspace" } ] }, "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{userAccessToken}}", "type": "string" } ] }, "description": "移除此前注册的客户端 MCP 服务器。\n\n在 `Authorization: Bearer ` 中传入用户 OAuth access token。客户端 MCP 的注册与通信接口不接受工作区 API key。", "body": { "mode": "raw", "raw": "{\n \"serverId\": \"{{serverId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ] }