{
"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/v1/w/{wId}/spaces/{spaceId}/data_sources/{dsId}/tables": {
"get": {
"summary": "Get tables",
"description": "Returns the tables available in data source {dsId} for workspace {wId}.",
"tags": [
"Datasources"
],
"security": [
{
"WorkspaceApiKey": []
},
{
"UserAccessToken": []
}
],
"parameters": [
{
"in": "path",
"name": "wId",
"required": true,
"description": "Unique string identifier for the workspace",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "spaceId",
"required": true,
"description": "ID of the space",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "dsId",
"required": true,
"description": "ID of the data source",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "The tables",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tables": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Table"
}
}
}
}
}
}
},
"400": {
"description": "Invalid request"
}
},
"x-counso-auth": "workspace"
}
}
},
"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": {
"Table": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the table",
"example": "Roi data",
"deprecated": true
},
"title": {
"type": "string",
"description": "Title of the table",
"example": "ROI Data"
},
"table_id": {
"type": "string",
"description": "Unique identifier for the table",
"example": "1234f4567c"
},
"description": {
"type": "string",
"description": "Description of the table",
"example": "roi data for Q1"
},
"mime_type": {
"type": "string",
"description": "MIME type of the table",
"example": "text/csv"
},
"schema": {
"type": "array",
"description": "Array of column definitions",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the column",
"example": "roi"
},
"value_type": {
"type": "string",
"description": "Data type of the column",
"enum": [
"text",
"int",
"float",
"bool",
"date"
],
"example": "int"
},
"possible_values": {
"type": "array",
"description": "Array of possible values for the column (null if unrestricted)",
"items": {
"type": "string"
},
"nullable": true,
"example": [
"1",
"2",
"3"
]
}
}
}
},
"timestamp": {
"type": "number",
"description": "Unix timestamp of table creation/modification",
"example": 1732810375150
},
"tags": {
"type": "array",
"description": "Array of tags associated with the table",
"items": {
"type": "string"
}
},
"parent_id": {
"type": "string",
"description": "ID of the table parent",
"items": {
"type": "string"
},
"example": "1234f4567c"
},
"parents": {
"type": "array",
"description": "Array of parent table IDs",
"items": {
"type": "string"
},
"example": [
"1234f4567c"
]
}
}
}
}
}
}
