{
"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}/check_upsert_queue": {
"get": {
"summary": "Check the upsert queue status for a data source",
"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.",
"tags": [
"Datasources"
],
"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"
}
}
],
"security": [
{
"WorkspaceApiKey": []
},
{
"UserAccessToken": []
}
],
"responses": {
"200": {
"description": "Status of the upsert queue",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"running_count": {
"type": "number",
"description": "Number of currently running upsert workflows"
}
}
}
}
}
},
"400": {
"description": "Bad Request. Missing or invalid parameters."
},
"401": {
"description": "Unauthorized. Invalid or missing authentication token."
},
"403": {
"description": "Forbidden. Only system keys can access this endpoint."
},
"404": {
"description": "Data source not found."
},
"500": {
"description": "Internal Server Error."
}
},
"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."
}
}
}
}
