{ "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": "Delete a table", "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": "Deletes table {tId} from data source {dsId} in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Delete a row", "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": "Removes row {rId} from table {tId} in data source {dsId}, within workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get data sources", "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": "Returns the data-source collection configured for workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Upsert a table", "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": "Creates a table in data source {dsId}, or applies updates to its existing definition, in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Upsert rows", "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": "Inserts new rows or updates existing ones in table {tId} of data source {dsId}, for workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Search the data source", "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": "Runs a search against data source {dsId} in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Retrieve a document from a data source", "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": "Fetches a document by its data-source ID {dsId} from workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Upsert a document in a data source", "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": "Creates or replaces a document entry in a workspace data source.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Get a row", "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": "Reads row {rId} from table {tId} in data source {dsId} under workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "List rows", "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": "Enumerates rows in table {tId} of data source {dsId} within workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get a table", "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": "Returns table {tId} from data source {dsId} in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Check the upsert queue status for a data source", "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": "Reports how many document upsert workflows are currently running for the data source. Calls are restricted to system API keys, such as those used by connectors.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get tables", "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": "Returns the tables available in data source {dsId} for workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Delete a document from a data source", "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": "Removes the chosen document from a workspace data source.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get documents", "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": "Lists documents belonging to data source {dsId} in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Update the parents of a document", "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": "Revises the parent links recorded for a document in data source {dsId} under workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"parent_id\": \"{{parent_id}}\",\n \"parents\": [\n \"{{parents}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List Data Source Views", "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": "Enumerates the data source views configured for the selected Space.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Update a data source view", "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": "Applies an update to a data source view in the chosen Space.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"parentsToAdd\": [\n \"{{parentId}}\"\n ],\n \"parentsToRemove\": []\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search the data source view", "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": "Searches within view {dsvId} in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Delete a data source view", "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": "Removes the selected data source view from its Space.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get a data source view", "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": "Returns the configuration and details for one data source view in a Space.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "List available MCP server views", "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": "Shows the enabled MCP server views (tools) available in a selected Space for this workspace.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get a trigger", "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": "Retrieve one scheduled-run or webhook trigger by its ID using a workspace-admin API key.\n\nUse a workspace-admin API key in `Authorization: Bearer `." }, "response": [] }, { "name": "List triggers", "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": "Returns the scheduled-run and webhook triggers configured throughout the workspace. A workspace-admin API key is required.\n\nUse a workspace-admin API key in `Authorization: Bearer `." }, "response": [] }, { "name": "List available spaces", "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": "Enumerates Spaces the authenticated user can access in the current workspace.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Import agent configuration", "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": "Accepts a JSON representation that conforms to the agent-config schema and creates a new configuration from it.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Search agents by 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": "Finds workspace {wId} agent configurations whose names match the supplied search.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "List agents", "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": "Returns the set of agent configurations belonging to workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get agent configuration", "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": "Looks up agent configuration {sId} and returns its details from workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Archive agent configuration", "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": "Soft-archives configuration {sId} in workspace {wId}; any triggers attached to that configuration are disabled.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Export agent configuration as 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": "Produces a downloadable YAML copy of the agent configuration selected by {sId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Update agent configuration", "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": "Applies changes to configuration {sId} within workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Get mention suggestions", "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": "Returns agent and user mention candidates matching the supplied query.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Parse mentions in markdown text", "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": "Converts @ references in pasted Markdown into the structured mention representation.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"markdown\": \"Hello @JohnDoe, can you help with @MyAgent?\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get mention suggestions for a conversation", "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": "Finds agent and user mention candidates for a search string, limited to the selected conversation.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Upload a tool file", "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": "Moves a file returned by an MCP server tool into the workspace by downloading and uploading its contents.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"serverViewId\": \"{{serverViewId}}\",\n \"externalId\": \"{{externalId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search for nodes in the workspace", "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": "Finds nodes in the workspace that match the supplied search criteria.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"query\": \"{{query}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Search for nodes in the workspace (streaming)", "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": "Searches workspace nodes and sends matching results incrementally over SSE.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Validate an action in a conversation message", "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": "Records an approval or rejection for an action attached to a conversation message.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"{{actionId}}\",\n \"approved\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Edit an existing message in a conversation", "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": "Changes the contents of a message that already exists in the specified conversation.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"content\": \"{{content}}\",\n \"mentions\": [\n {\n \"configurationId\": \"{{configurationId}}\"\n }\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a conversation", "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": "Changes a conversation's title or its read/unread state in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"read\": false\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a conversation", "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": "Reads a workspace conversation and its messages; limit and lastValue can be supplied to page through the message content.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Cancel message generation in a conversation", "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": "Stops the in-progress generation associated with the selected conversation.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"messageIds\": [\n \"{{messageIds}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get events for a message", "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": "Returns the event records associated with a message in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get the events for a conversation", "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": "Fetches the event history attached to a conversation in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Create a new conversation", "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": "Opens a fresh conversation in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Answer a user question in a conversation message", "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": "Submits the user's response to a question an Agent placed in a particular conversation message.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"actionId\": \"{{actionId}}\",\n \"answer\": {\n \"selectedOptions\": [\n 1\n ]\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Download a conversation-scoped file by path", "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": "Streams a conversation-mounted file using its scoped path. Prefer the canonical filePath listed under a message action's generatedFiles; the older conversation/foo.pdf form is also accepted. Paths belonging to another conversation or scope, including traversal with .., are rejected.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Create a message", "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": "Adds a message to conversation {cId} under workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Create a file upload URL", "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": "Allocates a workspace file record and supplies the URL where its contents should be uploaded.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Create a content fragment", "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": "Adds a newly created content fragment to a conversation in workspace {wId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"title\": \"My content fragment\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get feedbacks for a conversation", "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": "Returns every feedback entry recorded for the selected conversation. The authenticated caller must have the read:conversation scope.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Submit feedback for a specific message in a conversation", "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": "Stores a thumbs-up or thumbs-down rating for a particular conversation message. The authenticated caller must have the update:conversation scope.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "body": { "mode": "raw", "raw": "{\n \"thumbDirection\": \"up\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete feedback for a specific message", "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": "Removes a user's feedback entry attached to a message in a conversation. The authenticated caller must have the update:conversation scope.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "List 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": "Returns custom Skills in the workspace; unless requested otherwise, only active entries are included.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Import skills from uploaded files", "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": "Adds Skills to the workspace from uploaded files or a ZIP archive.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Archive a 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": "Marks a custom workspace Skill as archived without permanently deleting it.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "List apps", "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": "Returns the apps available in Space {spaceId}.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Get an app run", "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": "Looks up a previously created app run by its ID in the specified Space.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] }, { "name": "Create an app run", "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": "Starts an execution of app {aId} in Space {spaceId} and returns the resulting run.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources.", "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": "Export workspace analytics", "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": "Generates a workspace analytics export for {wId}, encoded as either CSV or JSON.\n\nSend a workspace API key or a user OAuth access token in `Authorization: Bearer `. The credential must belong to this Counso deployment and have access to the requested workspace and resources." }, "response": [] } ] }, { "name": "Sign-in flow", "item": [ { "name": "Exchange code or refresh token", "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": "Exchanges a WorkOS authorization code or refresh token for user access tokens as part of sign-in or session renewal. An existing Bearer token is not required.\n\nExchange an authorization code (and its PKCE verifier when applicable), or send grant_type=refresh_token with a refresh token. No existing Bearer token is required. JSON and form-encoded request bodies are accepted.", "body": { "mode": "raw", "raw": "{\n \"code\": \"{{authorizationCode}}\",\n \"code_verifier\": \"{{codeVerifier}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Revoke a session", "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": "Revokes the WorkOS session named in session_id to sign that session out. This endpoint does not require a Bearer token.\n\nSubmit the session_id to revoke that user session. This sign-out endpoint does not require a Bearer token.", "body": { "mode": "raw", "raw": "{\n \"session_id\": \"{{session_id}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Initiate WorkOS login", "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": "Starts authentication by redirecting the user to WorkOS AuthKit. Clients can supply PKCE parameters; no existing Bearer token is needed.\n\nStart user sign-in without an existing Bearer token. A client using PKCE supplies its registered redirect URI and code challenge. The response redirects the user to the identity provider." }, "response": [] } ] }, { "name": "User session API", "item": [ { "name": "List consumption analytics facets", "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": "Private session interface. Lists current and historical indexed values for each consumption dimension within the selected period. It disables a facet when other active filters leave no matching document. The workspace route requires a Manager, /me is limited to the signed-in member, and the agent route requires workspace Manager access or editor access to the selected Agent.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "Cancel a wake-up", "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": "Private session interface. Cancels a scheduled wake-up when requested by its owner or a workspace administrator.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get conversation participants", "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": "Private session interface. Lists the users participating in a selected conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Update a conversation", "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": "Private session interface. Changes the conversation title, read state, Space assignment, or URL-access mode.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"title\": \"{{title}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete or leave a conversation", "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": "Private session interface. Deletes the conversation, or leaves it when it is shared with others.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Cancel message generation", "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": "Private session interface. Halts the message-generation process running in the specified conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"action\": \"cancel\",\n \"messageIds\": [\n \"{{messageIds}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a conversation", "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": "Private session interface. Loads one conversation using its ID.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Add a participant to a conversation", "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": "Private session interface. Adds the signed-in user to the participant list for the specified conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "List conversations", "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": "Private session interface. Returns the signed-in user's conversations for this workspace as a paginated collection.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "List selectable Spaces", "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": "Private session interface. Shows regular Spaces the user can choose for a conversation and indicates which ones are selected now.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Create a conversation", "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": "Private session interface. Creates a conversation, optionally seeding it with a user message and content fragments.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "Get conversation feedbacks", "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": "Private session interface. Retrieves feedback that the signed-in user submitted for the specified conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "List wake-ups for a conversation", "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": "Private session interface. Lists every wake-up scheduled for the conversation, regardless of status.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Select Spaces for a conversation", "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": "Private session interface. Adds regular Spaces to the conversation's explicitly selected scope.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"mode\": \"add\",\n \"spaceIds\": [\n \"{{spaceIds}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Compact a conversation", "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": "Private session interface. Summarizes earlier messages into a compaction entry using the model supplied for summarization.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"model\": {\n \"providerId\": \"{{providerId}}\",\n \"modelId\": \"{{modelId}}\"\n }\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get a conversation credit attribution", "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": "Private session interface. Reports the latest stable credits billed for completed messages directly in this conversation, plus additional attribution calculated only from model-input rows. In-progress messages appear after reaching a terminal state.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Create a content fragment", "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": "Private session interface. Inserts a content fragment into an existing conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "Stream conversation events", "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": "Private session interface. Delivers conversation events in real time through SSE, routed via /api/sse/.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Stream sandbox function invocation events", "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": "Private session interface. Streams event updates for a Pod function invocation through SSE.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Stream message events", "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": "Private session interface. Streams live events for an Agent message over SSE; user messages are outside this endpoint's scope.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Create a file upload", "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": "Private session interface. Creates the file record first, then returns a pre-signed upload URL for the content.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"contentType\": \"{{contentType}}\",\n \"fileName\": \"{{fileName}}\",\n \"fileSize\": 1,\n \"useCase\": \"conversation\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get or download a file", "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": "Private session interface. Opens or downloads a file. Reading a Skill attachment requires read access to that Skill; version (original, processed, public) and action (view, download) select the returned content and operation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Delete a file", "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": "Private session interface. Removes a workspace file unless a Skill or its version history still references it.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Upload file content", "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": "Private session interface. Processes the supplied file bytes and saves the resulting content.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "formdata", "formdata": [ { "key": "file", "type": "file" } ] } }, "response": [] }, { "name": "Get mention suggestions", "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": "Private session interface. Provides mention suggestions available in the workspace.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get workspace feature flags", "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": "Private session interface. Lists the feature flags currently enabled for the workspace.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Update current user", "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": "Private session interface. Saves profile changes for the current user, including name, job type, favorite platforms, and image.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"firstName\": \"{{firstName}}\",\n \"lastName\": \"{{lastName}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get current user", "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": "Private session interface. Returns the signed-in user's profile together with associated workspaces and subscriber hash.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Retry an agent message", "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": "Private session interface. Starts another generation attempt for an Agent response, optionally limiting retries to blocked actions.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get an agent message credit attribution", "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": "Private session interface. Gives direct and total billed credits for an Agent message; run-agent tool rows include the invocation and charges from its sub-agent tree.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Submit message feedback", "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": "Private session interface. Creates or revises a thumbs-up/down rating for an Agent message.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"thumbDirection\": \"up\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Delete message feedback", "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": "Private session interface. Clears the signed-in user's feedback on the selected Agent message.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get a message", "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": "Private session interface. Loads one message by ID from a conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Post a message to a conversation", "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": "Private session interface. Adds a user message to an existing conversation and starts the Agent response flow.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "Get a single action", "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": "Private session interface. Returns one action attached to an Agent message together with that message's status.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "List messages in a conversation", "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": "Private session interface. Pages through the messages belonging to a selected conversation.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Delete a message", "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": "Private session interface. Soft-deletes a user or Agent message without removing the conversation itself.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Edit a message", "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": "Private session interface. Revises an existing user message, including its text and mentions.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "Resolve a conversation go template draft", "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": "Private session interface. Resolves a Contentful conversation template from its slug and prepares a composer-ready draft, with optional attachments uploaded in advance.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Delete a 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": "Private session interface. Deletes one Space from the workspace.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Create a 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": "Private session interface. Creates a Space inside the workspace.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"isRestricted\": false,\n \"name\": \"{{name}}\",\n \"spaceKind\": \"regular\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List data source views", "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": "Private session interface. Lists every data source view attached to the chosen Space.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Create a data source view", "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": "Private session interface. Adds a new data source view to the specified Space.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"dataSourceId\": \"{{dataSourceId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update a 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": "Private session interface. Changes properties on the specified Space.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "List spaces", "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": "Private session interface. Provides the collection of Spaces in the workspace.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Update a data source view", "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": "Private session interface. Modifies the selected data source view.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"parentsIn\": [\n \"{{parentsIn}}\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Set project notification preference", "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": "Stores a per-user notification setting for the selected project Space.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"preference\": \"all_messages\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Get project notification preference", "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": "Private session interface. Reads the signed-in user's notification preference for a project Space.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get a 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": "Private session interface. Returns a Space record with its categories, members, and permissions.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Delete a data source view", "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": "Private session interface. Removes a selected data source view.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get a data source view", "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": "Private session interface. Loads the requested data source view's details.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Create an agent configuration", "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": "Private session interface. Creates a workspace agent configuration for the signed-in user.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "body": { "mode": "raw", "raw": "{\n \"assistant\": {}\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "List agent configurations", "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": "Private session interface. Supplies the signed-in user's collection of workspace agent configurations.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "Get extension configuration", "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": "Private session interface. Returns extension settings for the workspace, including its blocked-domain list.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity." }, "response": [] }, { "name": "List personal consumption analytics facets", "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": "Return filter values for the signed-in member’s consumption during the selected period. The server limits this route to that member; user and group dimensions are omitted. Filters on other dimensions determine which values remain available.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "List agent consumption analytics facets", "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": "Return the available consumption filters for one agent in the selected period. Workspace managers and editors of that agent can use this route. The agent dimension is omitted, and active filters determine which other values are available.\n\nThis operation requires a user OAuth access token in `Authorization: Bearer `. A signed-in browser may use its Counso session cookie. A workspace API key does not supply user identity.", "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": "Receive external webhook to trigger flows", "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": "Accepts a JSON event at the source-specific webhook URL, which contains a secret. When signature verification is enabled for that source, the request must carry a valid signature over the raw request body.\n\nUse the complete webhook URL generated for this source, including its URL secret. This endpoint does not use an API key. If signature verification is configured, include the configured signature header and sign the exact raw request body. Keep the generated URL private.", "body": { "mode": "raw", "raw": "{}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] }, { "name": "Client-side MCP · user OAuth", "item": [ { "name": "Register a client-side MCP server", "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": "Registers a client-side MCP server for the signed-in user in this workspace and returns its generated serverId.\n\nUse a user OAuth access token in `Authorization: Bearer `. Workspace API keys are not accepted by client-side MCP registration and transport endpoints.", "body": { "mode": "raw", "raw": "{\n \"serverName\": \"{{serverName}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Update heartbeat for a client-side MCP server", "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": "Renews a registered client-side MCP server's heartbeat so its registration TTL remains active.\n\nUse a user OAuth access token in `Authorization: Bearer `. Workspace API keys are not accepted by client-side MCP registration and transport endpoints.", "body": { "mode": "raw", "raw": "{\n \"serverId\": \"{{serverId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Stream MCP tool requests for a workspace", "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": "Opens an SSE stream that delivers workspace tool requests to connected client-side MCP servers as they are issued.\n\nUse a user OAuth access token in `Authorization: Bearer `. Workspace API keys are not accepted by client-side MCP registration and transport endpoints." }, "response": [] }, { "name": "Submit MCP tool execution results", "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": "Sends back the output produced by tools that a client-side MCP server ran locally.\n\nUse a user OAuth access token in `Authorization: Bearer `. Workspace API keys are not accepted by client-side MCP registration and transport endpoints.", "body": { "mode": "raw", "raw": "{\n \"result\": {},\n \"serverId\": \"{{serverId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] }, { "name": "Deregister a client-side MCP server", "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": "Removes the registration for a client-side MCP server that was registered earlier.\n\nUse a user OAuth access token in `Authorization: Bearer `. Workspace API keys are not accepted by client-side MCP registration and transport endpoints.", "body": { "mode": "raw", "raw": "{\n \"serverId\": \"{{serverId}}\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [] } ] } ] }