{
"openapi": "3.0.0",
"info": {
"title": "Counso API",
"version": "1.0.2",
"description": "API reference for Counso workspaces, Agents, conversations and data sources.",
"license": {
"name": "MIT",
"url": "https://opensource.org/licenses/MIT"
}
},
"servers": [
{
"url": "https://app.counso.ai",
"description": "Counso"
}
],
"paths": {
"/api/w/{wId}/spaces/{spaceId}/project_notification_preferences": {
"patch": {
"summary": "Set project notification preference",
"description": "Stores a per-user notification setting for the selected project Space.",
"tags": [
"Private Spaces"
],
"parameters": [
{
"in": "path",
"name": "wId",
"required": true,
"description": "ID of the workspace",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "spaceId",
"required": true,
"description": "ID of the project space",
"schema": {
"type": "string"
}
}
],
"security": [
{
"UserAccessToken": []
},
{
"BrowserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"preference"
],
"properties": {
"preference": {
"type": "string",
"enum": [
"all_messages",
"only_mentions",
"never"
]
}
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"userProjectNotificationPreference": {
"type": "object",
"nullable": true,
"properties": {
"sId": {
"type": "string"
},
"spaceId": {
"type": "string"
},
"userId": {
"type": "string"
},
"preference": {
"type": "string",
"enum": [
"all_messages",
"only_mentions",
"never"
]
}
}
}
}
}
}
}
},
"400": {
"description": "Bad request (space is not a project or invalid body)"
},
"401": {
"description": "Unauthorized"
}
},
"x-counso-auth": "user"
}
}
},
"components": {
"securitySchemes": {
"WorkspaceApiKey": {
"type": "http",
"scheme": "bearer",
"description": "A workspace API key issued by this Counso deployment. Permissions and resource access are checked for each operation."
},
"UserAccessToken": {
"type": "http",
"scheme": "bearer",
"description": "A user OAuth access token issued for this Counso deployment. A workspace API key is not a substitute for a user token."
},
"BrowserSession": {
"type": "apiKey",
"in": "cookie",
"name": "workos_session",
"description": "The signed-in Counso browser session. External clients should use a user access token."
}
}
}
}
