1Copy Semantic Model

1Copy Semantic Model

Overview

This API copies a Semantic Model to the specified target folder.

Method: POST

Request URL: {kyvos-url}/rest/v2/semantic-models/{name-or-id}/copy


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

Header Name

Type

Description

Possible Values

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded

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

Parameter Name

Type

Description

Possible Values

name-or-id (Required)

String

Name or ID of the source Semantic Model that needs to be copied.

Note: If the Semantic Model name is provided, then sourceFolderName must also be provided in request body.

–


Query Parameters

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

by

String

Specifies whether the name-or-id parameter should be interpreted as a Semantic Model name or Semantic Model ID.

If by=name, provide the Semantic Model name in the name-or-id parameter.

If by=id, provide the Semantic Model ID in the name-or-id parameter.

The default value is name.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

sourceFolderName

String

Name of the folder from which the Semantic Model will be copied. If the Semantic Model is present in the root directory, specify [Root].

Note: If sourceFolderName is not provided, the source Semantic Model will be treated as a root-level entity by default.

–

targetSmodelName (Required)

String

Name of the Semantic Model copy to be created.

–

targetFolderName

String

Name of the target folder where the Semantic Model copy is created. If you want to copy the Semantic Model to the root directory, specify [Root].

Note: If neither targetFolderName nor targetFolderId is provided, the API will create a copy of the Semantic Model in the root directory.

–

targetFolderId

String

ID of the target folder where the copied Semantic Model will be created.

–

copyLinkedData

Boolean

Indicates whether the historical queries of the source Semantic Model should be linked to the copied Semantic Model.

true / false

Default: false


Responses

200 Success

{ "code": 0, "message": "Semantic model copied successfully." }

Status Code

Description

Status Code

Description

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Parameter missing.

500

Internal Server Error


Copyright Kyvos, Inc. 2026. All rights reserved.