Get AI Tools
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves the AI tools configured for an AI Space, including their details and configuration information.
Method: GET
Request URL: {kyvos-url}/rest/v2/ai-spaces/{name-or-id}/ai-tools
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
sessionid | String | The session ID is the token received from the Login API. Note: Session ID is required for token-based authentication. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the AI Space from which you want to retrieve the configured AI tools. Note: If the AI Space name is provided, then either folderName or folderId must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as an AI Space name or an AI Space ID. If by=name, provide the AI Space name in the name-or-id parameter. If by=id, provide the AI Space ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the AI Space. If the AI Space is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the AI Space is treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the AI Space. | – |
Responses
200 Success
{
"plannerConfig": {
"instructions": ""
},
"aiSpaceName": "TestingIROSave",
"aiSpaceId": "17708039050628127060071153969641",
"tools": [
{
"toolId": "generateAndExecuteSQL",
"instanceId": "17811868205249127025095126252720",
"config": {
"instructions": "",
"prerequisiteTools": [
"17811868205244127011030120827701"
],
"purpose": "",
"displayName": "SQL Generator and Executor"
},
"toolType": "generateAndExecuteSQL",
"enabled": true
},
{
"toolId": "lookupKB",
"instanceId": "17811868205242127011091151252166",
"config": {
"topK": 5,
"instructions": "",
"prerequisiteTools": [],
"enableSummarization": false,
"thresholdScore": 0.7,
"applicableUsecases": [
"KYVOS_DIALOGS",
"MCP"
],
"purpose": "",
"displayName": "Lookup Knowledge Base",
"summarizationPromptContext": "",
"content": ""
},
"toolType": "lookupKB",
"enabled": false
},
{
"toolId": "webSearch",
"instanceId": "17811868205244127011030120827701",
"config": {
"instructions": "",
"prerequisiteTools": [],
"allowedDomains": [],
"applicableUsecases": [
"KYVOS_DIALOGS"
],
"purpose": "",
"displayName": "Web and URL Search",
"searchContextSize": "medium"
},
"toolType": "webSearch",
"enabled": false
},
{
"toolId": "codeGenAndExecutor",
"instanceId": "17811868205249127056048162048884",
"config": {
"instructions": "",
"prerequisiteTools": [],
"applicableUsecases": [
"KYVOS_DIALOGS"
],
"purpose": "",
"displayName": "Code Generator and Executor"
},
"toolType": "codeGenAndExecutor",
"enabled": false
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |