1Process Semantic Model
Overview
This API processes a Semantic Model to pre-aggregate massive data volumes and deliver high-performance querying.
Method: POST
Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/schedule-jobs
💡 API Update
Starting with Release 2026.8, a new endpoint is introduced for this API, as provided above. The previously used endpoint, {kyvos-url}/rest/v2/semantic-models/{name-or-id}/schedules, is now deprecated. For new integrations, use the new endpoint provided on this page. For details about the deprecated endpoint, refer to the 2026.7 Documentation.
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 |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
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 Semantic Model to be processed. Note: If the Semantic Model name is provided, then either | — |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the
Default: | — |
folderName | String | Name of the folder containing the Semantic Model. If the Semantic Model is present in the root directory, specify Note: If neither | — |
folderId | String | ID of the folder containing the Semantic Model. | — |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
requestJson (Required) | String | JSON containing all the details required for processing the Semantic Model. | — |
Responses
200 Success
{
"code": 0,
"message": "Successfully added schedule"
}Error Responses
Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error. |
Resources
Below are example JSON structures for different request body parameters.
requestJson (Full build)
This is the most complete example. Use it as the starting point and refer to the sections below for what to change for different build types or schedules.
{
"jobType": "FULL",
"buildSourceDatasets": "IFNEEDED",
"aggregationStrategy": 0,
"recommendationInputParams": {
"QUERY_DAYS": "30",
"AGGREGATION_STRATEGY_TYPE": "ONLY_AGGREGATION",
"RECOMMENDATION_TYPE": "AGGREGATION"
},
"batchDetails": {
"attachmentFormat": "NONE",
"segmentCapacity": "1",
"userParams": {},
"deliveryOperations": {}
},
"jobDetails": {
"runType": "ONCE",
"onceDate": "07/29/2026",
"onceTime": "15:36",
"onceEndDate": "",
"onceEndTime": "",
"timeZone": "",
"partitionReplacement": {
"replacePartition": false,
"excludeCurrPartition": true
},
"batchId": "390af3e4634af9ce8ffe15b9bb0d865d",
"ownerId": "402343863",
"name": "390af3e4634af9ce8ffe15b9bb0d865d",
"id": "96c3a3705824a7284f6b0d0998ce30da",
"scheduleId": ""
}
}