{
"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}/documents": {
"get": {
"summary": "Get documents",
"description": "Lists documents belonging to data source {dsId} in workspace {wId}.",
"tags": [
"Datasources"
],
"security": [
{
"WorkspaceApiKey": []
},
{
"UserAccessToken": []
}
],
"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 space",
"schema": {
"type": "string"
}
},
{
"in": "path",
"name": "dsId",
"required": true,
"description": "ID of the data source",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "document_ids",
"description": "The IDs of the documents to fetch (optional)",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"in": "query",
"name": "limit",
"description": "Limit the number of documents returned",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "offset",
"description": "Offset the returned documents",
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "The documents",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Document"
}
},
"total": {
"type": "integer"
}
}
}
}
}
},
"404": {
"description": "The data source was not found"
}
},
"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": {
"Document": {
"type": "object",
"properties": {
"data_source_id": {
"type": "string",
"example": "3b7d9f1e5a"
},
"created": {
"type": "number",
"example": 1625097600
},
"document_id": {
"type": "string",
"example": "2c4a6e8d0f"
},
"title": {
"type": "string",
"description": "Title of the document",
"example": "Customer Support FAQ"
},
"mime_type": {
"type": "string",
"description": "MIME type of the table",
"example": "text/md"
},
"timestamp": {
"type": "number",
"example": 1625097600
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"customer_support",
"faq"
]
},
"parent_id": {
"type": "string",
"description": "ID of the document parent",
"items": {
"type": "string"
},
"example": "1234f4567c"
},
"parents": {
"type": "array",
"items": {
"type": "string"
},
"example": [
"7b9d1f3e5a",
"2c4a6e8d0f"
]
},
"source_url": {
"type": "string",
"nullable": true,
"example": "https://example.com/support/article1"
},
"hash": {
"type": "string",
"example": "a1b2c3d4e5"
},
"text_size": {
"type": "number",
"example": 1024
},
"chunk_count": {
"type": "number",
"example": 5
},
"chunks": {
"type": "array",
"items": {
"type": "object"
},
"example": [
{
"chunk_id": "9f1d3b5a7c",
"text": "This is the first chunk of the document.",
"embedding": [
0.1,
0.2,
0.3,
0.4
]
},
{
"chunk_id": "4a2c6e8b0d",
"text": "This is the second chunk of the document.",
"embedding": [
0.5,
0.6,
0.7,
0.8
]
}
]
},
"text": {
"type": "string",
"example": "This is the full text content of the document. It contains multiple paragraphs and covers various topics related to customer support."
},
"token_count": {
"type": "number",
"nullable": true,
"example": 150
}
}
}
}
}
}
