{
"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}/assistant/conversations": {
"post": {
"summary": "Create a conversation",
"description": "Private session interface. Creates a conversation, optionally seeding it with a user message and content fragments.",
"tags": [
"Private Conversations"
],
"parameters": [
{
"in": "path",
"name": "wId",
"required": true,
"description": "ID of the workspace",
"schema": {
"type": "string"
}
}
],
"security": [
{
"UserAccessToken": []
},
{
"BrowserSession": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"title": {
"type": "string",
"nullable": true
},
"visibility": {
"type": "string",
"enum": [
"unlisted",
"deleted",
"test"
]
},
"spaceId": {
"type": "string",
"nullable": true
},
"message": {
"type": "object",
"properties": {
"content": {
"type": "string"
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateMention"
}
},
"context": {
"type": "object",
"properties": {
"timezone": {
"type": "string"
},
"profilePictureUrl": {
"type": "string",
"nullable": true
},
"origin": {
"type": "string",
"nullable": true
},
"clientSideMCPServerIds": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedMCPServerViewIds": {
"type": "array",
"items": {
"type": "string"
}
},
"selectedSpaceIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"contentFragments": {
"type": "array",
"items": {
"type": "object"
}
},
"metadata": {
"type": "object",
"nullable": true,
"properties": {
"useDatabaseFileSystem": {
"type": "boolean",
"description": "Use the database-backed filesystem for a fresh standalone conversation."
}
}
},
"selectedSpaceIds": {
"type": "array",
"items": {
"type": "string"
}
},
"skipToolsValidation": {
"type": "boolean"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Successfully created conversation",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"conversation": {
"$ref": "#/components/schemas/PrivateFullConversation"
},
"message": {
"$ref": "#/components/schemas/PrivateUserMessage"
},
"contentFragments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateContentFragment"
}
}
}
}
}
}
},
"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."
}
},
"schemas": {
"PrivateContentFragment": {
"type": "object",
"description": "A content fragment (file or content node attachment) in a conversation.",
"required": [
"type",
"sId",
"title",
"contentType",
"contentFragmentType"
],
"properties": {
"type": {
"type": "string",
"enum": [
"content_fragment"
]
},
"id": {
"type": "integer"
},
"sId": {
"type": "string"
},
"created": {
"type": "integer"
},
"visibility": {
"type": "string",
"enum": [
"visible",
"deleted"
]
},
"version": {
"type": "integer"
},
"rank": {
"type": "integer"
},
"title": {
"type": "string"
},
"contentType": {
"type": "string",
"description": "MIME type of the content"
},
"sourceUrl": {
"type": "string",
"nullable": true
},
"context": {
"type": "object",
"properties": {
"username": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePictureUrl": {
"type": "string",
"nullable": true
}
}
},
"contentFragmentId": {
"type": "string"
},
"contentFragmentVersion": {
"type": "string",
"enum": [
"superseded",
"latest"
]
},
"contentFragmentType": {
"type": "string",
"enum": [
"file",
"content_node"
],
"description": "Whether this is a file upload or a content node reference"
},
"expiredReason": {
"type": "string",
"nullable": true,
"enum": [
"data_source_deleted"
]
},
"fileId": {
"type": "string",
"nullable": true,
"description": "Present for file content fragments"
},
"path": {
"type": "string",
"nullable": true,
"description": "Path of this file inside the sandbox conversation mount."
},
"processedPath": {
"type": "string",
"nullable": true,
"description": "Path of the plain-text sibling of this file inside the sandbox conversation mount (e.g. an audio transcript), when it has one."
},
"skipFileProcessing": {
"type": "boolean",
"description": "Whether upload-time file processing was skipped."
},
"snippet": {
"type": "string",
"nullable": true
},
"textUrl": {
"type": "string",
"nullable": true
},
"textBytes": {
"type": "integer",
"nullable": true
},
"nodeId": {
"type": "string",
"nullable": true,
"description": "Present for content node fragments"
},
"nodeDataSourceViewId": {
"type": "string",
"nullable": true
}
}
},
"PrivateFullConversation": {
"type": "object",
"description": "Full conversation including content, owner, and visibility.",
"allOf": [
{
"$ref": "#/components/schemas/PrivateConversation"
},
{
"type": "object",
"properties": {
"owner": {
"$ref": "#/components/schemas/PrivateWorkspace"
},
"visibility": {
"type": "string",
"enum": [
"unlisted",
"deleted",
"test"
]
},
"content": {
"type": "array",
"description": "Array of message arrays (versions/retries)",
"items": {
"type": "array",
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/PrivateUserMessage"
},
{
"$ref": "#/components/schemas/PrivateAgentMessage"
},
{
"$ref": "#/components/schemas/PrivateContentFragment"
},
{
"$ref": "#/components/schemas/PrivateCompactionMessage"
}
]
}
}
}
}
}
]
},
"PrivateAgentMessage": {
"type": "object",
"description": "An agent message in a conversation.",
"required": [
"type",
"sId",
"version",
"rank",
"status",
"parentMessageId"
],
"properties": {
"id": {
"type": "integer"
},
"agentMessageId": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"agent_message"
]
},
"sId": {
"type": "string"
},
"created": {
"type": "integer"
},
"completedTs": {
"type": "integer",
"nullable": true
},
"visibility": {
"type": "string",
"enum": [
"visible",
"deleted"
]
},
"version": {
"type": "integer"
},
"rank": {
"type": "integer"
},
"branchId": {
"type": "string",
"nullable": true,
"description": "Legacy, always null. Branches were removed."
},
"parentMessageId": {
"type": "string"
},
"parentAgentMessageId": {
"type": "string",
"nullable": true,
"description": "If handover, the agent message that summoned this agent"
},
"status": {
"type": "string",
"enum": [
"created",
"succeeded",
"failed",
"cancelled"
]
},
"content": {
"type": "string",
"nullable": true
},
"chainOfThought": {
"type": "string",
"nullable": true
},
"error": {
"type": "object",
"nullable": true,
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"metadata": {
"type": "object",
"nullable": true
}
}
},
"configuration": {
"$ref": "#/components/schemas/PrivateLightAgentConfiguration"
},
"actions": {
"type": "array",
"items": {
"type": "object"
},
"description": "MCP actions executed by the agent"
},
"contents": {
"type": "array",
"items": {
"type": "object",
"properties": {
"step": {
"type": "integer"
},
"content": {
"type": "object"
}
}
}
},
"skipToolsValidation": {
"type": "boolean"
},
"richMentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateRichMentionWithStatus"
}
},
"completionDurationMs": {
"type": "integer",
"nullable": true
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateReaction"
}
},
"costCredits": {
"type": "integer",
"nullable": true,
"description": "Cost of producing this agent message, in credits (intelligence + tool credits). Null when no billable usage is attributed to the message."
},
"subAgentCostCredits": {
"type": "number",
"nullable": true,
"description": "Aggregated credit cost of all sub-agents (run_agent / agent_handover) spawned recursively by this message. Computed only on single-message fetches. Null otherwise."
},
"resolvedModel": {
"type": "object",
"nullable": true,
"description": "Model triplet used to generate the message. Null when the agent ran its configured model (legacy).",
"properties": {
"providerId": {
"type": "string"
},
"modelId": {
"type": "string"
},
"reasoningEffort": {
"type": "string"
}
}
},
"modelResolutionMethod": {
"type": "string",
"nullable": true,
"enum": [
"agent",
"user",
"auto",
"auto_fast",
"auto_complex",
"fair_use_downgrade"
],
"description": "How resolvedModel was chosen - agent (configured model), user (per-message picker), auto/auto_fast/auto_complex (routed through a model stream), or fair_use_downgrade (premium allowance spent, ran the Standard stream instead). Null (legacy)."
}
}
},
"PrivateCompactionMessage": {
"type": "object",
"description": "A compaction message summarizing earlier conversation content.",
"required": [
"type",
"sId",
"status",
"version",
"rank",
"created"
],
"properties": {
"type": {
"type": "string",
"enum": [
"compaction_message"
]
},
"id": {
"type": "integer"
},
"compactionMessageId": {
"type": "integer"
},
"sId": {
"type": "string"
},
"created": {
"type": "integer"
},
"visibility": {
"type": "string",
"enum": [
"visible",
"deleted"
]
},
"version": {
"type": "integer"
},
"rank": {
"type": "integer"
},
"branchId": {
"type": "string",
"nullable": true,
"description": "Legacy, always null. Branches were removed."
},
"sourceConversationId": {
"type": "string",
"nullable": true
},
"status": {
"type": "string",
"enum": [
"created",
"succeeded",
"failed"
]
},
"content": {
"type": "string",
"nullable": true,
"description": "Compacted summary. Null while status is \"created\"."
}
}
},
"PrivateConversation": {
"type": "object",
"description": "Conversation without content, used in list responses.",
"required": [
"id",
"created",
"updated",
"sId",
"depth"
],
"properties": {
"id": {
"type": "integer"
},
"created": {
"type": "integer",
"description": "Unix timestamp of creation"
},
"updated": {
"type": "integer",
"description": "Unix timestamp of last update"
},
"unread": {
"type": "boolean"
},
"lastReadMs": {
"type": "integer",
"nullable": true
},
"actionRequired": {
"type": "boolean",
"description": "Whether the conversation requires user action"
},
"hasError": {
"type": "boolean"
},
"sId": {
"type": "string"
},
"title": {
"type": "string",
"nullable": true
},
"spaceId": {
"type": "string",
"nullable": true,
"description": "ID of the space the conversation belongs to (for project conversations)"
},
"triggerId": {
"type": "string",
"nullable": true
},
"depth": {
"type": "integer",
"description": "Conversation depth (for agent handover chains)"
},
"metadata": {
"type": "object",
"additionalProperties": true
},
"requestedSpaceIds": {
"type": "array",
"items": {
"type": "string"
}
},
"forkingData": {
"$ref": "#/components/schemas/PrivateConversationForkingData"
}
}
},
"PrivateConversationForkingData": {
"type": "object",
"properties": {
"forkedFrom": {
"$ref": "#/components/schemas/PrivateConversationForkedFrom"
},
"forkedChildren": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateConversationForkedChild"
}
}
}
},
"PrivateConversationForkedChild": {
"type": "object",
"properties": {
"childConversationId": {
"type": "string"
},
"childConversationTitle": {
"type": "string",
"nullable": true
},
"sourceMessageId": {
"type": "string"
},
"branchedAt": {
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/PrivateConversationForkUser"
}
}
},
"PrivateConversationForkUser": {
"type": "object",
"properties": {
"sId": {
"type": "string"
},
"id": {
"type": "integer"
},
"createdAt": {
"type": "integer"
},
"provider": {
"type": "string",
"nullable": true,
"enum": [
"auth0",
"github",
"google",
"okta",
"samlp",
"waad"
]
},
"username": {
"type": "string"
},
"email": {
"type": "string"
},
"firstName": {
"type": "string"
},
"lastName": {
"type": "string",
"nullable": true
},
"fullName": {
"type": "string"
},
"image": {
"type": "string",
"nullable": true
},
"lastLoginAt": {
"type": "integer",
"nullable": true
}
}
},
"PrivateConversationForkedFrom": {
"type": "object",
"required": [
"parentConversationId",
"parentConversationTitle",
"sourceMessageId",
"branchedAt",
"user",
"fileCopyStatus"
],
"properties": {
"parentConversationId": {
"type": "string"
},
"parentConversationTitle": {
"type": "string",
"nullable": true
},
"sourceMessageId": {
"type": "string"
},
"branchedAt": {
"type": "integer"
},
"user": {
"$ref": "#/components/schemas/PrivateConversationForkUser"
},
"fileCopyStatus": {
"type": "string",
"enum": [
"pending",
"done"
]
}
}
},
"PrivateLightAgentConfiguration": {
"type": "object",
"description": "Agent configuration as returned by the private list endpoint.",
"required": [
"id",
"sId",
"version",
"name",
"description",
"pictureUrl",
"status",
"scope",
"model",
"maxStepsPerRun",
"tags"
],
"properties": {
"id": {
"type": "integer"
},
"sId": {
"type": "string"
},
"version": {
"type": "integer"
},
"versionCreatedAt": {
"type": "string",
"nullable": true
},
"versionAuthorId": {
"type": "integer",
"nullable": true
},
"name": {
"type": "string"
},
"description": {
"type": "string"
},
"instructions": {
"type": "string",
"nullable": true
},
"pictureUrl": {
"type": "string"
},
"status": {
"type": "string",
"description": "Agent status",
"enum": [
"active",
"archived",
"draft",
"pending",
"disabled_by_admin",
"disabled_missing_datasource",
"disabled_free_workspace"
]
},
"scope": {
"type": "string",
"enum": [
"global",
"visible",
"hidden"
]
},
"userFavorite": {
"type": "boolean"
},
"model": {
"type": "object",
"properties": {
"providerId": {
"type": "string"
},
"modelId": {
"type": "string"
},
"temperature": {
"type": "number"
},
"reasoningEffort": {
"type": "string",
"enum": [
"none",
"light",
"medium",
"high"
]
}
}
},
"maxStepsPerRun": {
"type": "integer"
},
"tags": {
"type": "array",
"items": {
"type": "object",
"properties": {
"sId": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
"templateId": {
"type": "string",
"nullable": true
},
"requestedGroupIds": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "string"
}
}
},
"requestedSpaceIds": {
"type": "array",
"items": {
"type": "string"
}
},
"canRead": {
"type": "boolean"
},
"canEdit": {
"type": "boolean"
},
"lastAuthors": {
"type": "array",
"description": "Optional, returned when withAuthors query param is set",
"items": {
"type": "string"
}
},
"editors": {
"type": "array",
"description": "Optional, returned when withEditors query param is set",
"items": {
"type": "object",
"properties": {
"sId": {
"type": "string"
},
"fullName": {
"type": "string"
},
"image": {
"type": "string",
"nullable": true
}
}
}
},
"usage": {
"type": "object",
"description": "Optional, returned when withUsage query param is set",
"properties": {
"messageCount": {
"type": "integer"
},
"conversationCount": {
"type": "integer"
},
"userCount": {
"type": "integer"
},
"timePeriodSec": {
"type": "integer"
}
}
},
"feedbacks": {
"type": "object",
"description": "Optional, returned when withFeedbacks query param is set",
"properties": {
"up": {
"type": "integer"
},
"down": {
"type": "integer"
}
}
}
}
},
"PrivateMention": {
"type": "object",
"description": "A mention in a message (agent or user).",
"properties": {
"configurationId": {
"type": "string",
"description": "Agent configuration sId (for agent mentions)"
},
"type": {
"type": "string",
"enum": [
"user"
],
"description": "Present only for user mentions"
},
"userId": {
"type": "string",
"description": "User sId (for user mentions)"
}
}
},
"PrivateReaction": {
"type": "object",
"description": "A reaction on a message.",
"required": [
"emoji",
"users"
],
"properties": {
"emoji": {
"type": "string"
},
"users": {
"type": "array",
"items": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"nullable": true
},
"username": {
"type": "string"
},
"fullName": {
"type": "string",
"nullable": true
}
}
}
}
}
},
"PrivateRichMentionWithStatus": {
"type": "object",
"description": "A rich mention with approval status, used in message responses.",
"required": [
"id",
"type",
"label",
"pictureUrl",
"description",
"dismissed",
"status"
],
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"agent",
"user"
]
},
"label": {
"type": "string"
},
"pictureUrl": {
"type": "string"
},
"description": {
"type": "string"
},
"userFavorite": {
"type": "boolean"
},
"dismissed": {
"type": "boolean"
},
"status": {
"type": "string",
"enum": [
"pending_conversation_access",
"pending_project_membership",
"approved",
"rejected",
"user_restricted_by_conversation_access",
"agent_restricted_by_space_usage"
]
}
}
},
"PrivateUserMessage": {
"type": "object",
"description": "A user message in a conversation.",
"required": [
"type",
"sId",
"content",
"version",
"rank",
"created"
],
"properties": {
"id": {
"type": "integer"
},
"type": {
"type": "string",
"enum": [
"user_message"
]
},
"sId": {
"type": "string"
},
"created": {
"type": "integer"
},
"visibility": {
"type": "string",
"enum": [
"visible",
"deleted"
]
},
"version": {
"type": "integer"
},
"rank": {
"type": "integer"
},
"branchId": {
"type": "string",
"nullable": true,
"description": "Legacy, always null. Branches were removed."
},
"user": {
"type": "object",
"nullable": true,
"description": "The user who sent the message",
"properties": {
"sId": {
"type": "string"
},
"username": {
"type": "string"
},
"fullName": {
"type": "string"
},
"image": {
"type": "string",
"nullable": true
}
}
},
"mentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateMention"
}
},
"richMentions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateRichMentionWithStatus"
}
},
"content": {
"type": "string"
},
"context": {
"$ref": "#/components/schemas/PrivateUserMessageContext"
},
"reactions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PrivateReaction"
}
}
}
},
"PrivateUserMessageContext": {
"type": "object",
"description": "Context metadata for a user message.",
"required": [
"username",
"timezone",
"origin"
],
"properties": {
"username": {
"type": "string"
},
"fullName": {
"type": "string",
"nullable": true
},
"email": {
"type": "string",
"nullable": true
},
"profilePictureUrl": {
"type": "string",
"nullable": true
},
"timezone": {
"type": "string"
},
"origin": {
"type": "string",
"enum": [
"web",
"project_kickoff",
"extension",
"agent_sidekick",
"analytics_panel",
"api",
"cli",
"cli_programmatic",
"email",
"excel",
"gsheet",
"make",
"n8n",
"powerpoint",
"raycast",
"slack",
"slack_workflow",
"teams",
"transcript",
"triggered_programmatic",
"triggered",
"wakeup",
"zapier",
"zendesk",
"onboarding_conversation"
]
},
"selectedSpaceIds": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"PrivateWorkspace": {
"type": "object",
"description": "Workspace as returned by the private API, includes SSO and provider settings.",
"required": [
"id",
"sId",
"name",
"role",
"regionalModelsOnly"
],
"properties": {
"id": {
"type": "integer"
},
"sId": {
"type": "string"
},
"name": {
"type": "string"
},
"role": {
"type": "string",
"enum": [
"admin",
"builder",
"user",
"none"
]
},
"segmentation": {
"type": "string",
"nullable": true
},
"whiteListedProviders": {
"type": "array",
"nullable": true,
"items": {
"type": "string"
},
"description": "Allowed model provider IDs"
},
"defaultEmbeddingProvider": {
"type": "string",
"nullable": true
},
"ssoEnforced": {
"type": "boolean"
},
"regionalModelsOnly": {
"type": "boolean",
"description": "When true, only models whose regionalAvailability includes the workspace's region are usable."
},
"metadata": {
"type": "object",
"nullable": true,
"additionalProperties": true
}
}
}
}
}
}
