Copy AI Space

Copy AI Space

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here.

Overview

This API copies an AI Space to the specified target folder.

Method: POST

Request URL: {kyvos-url}/rest/v2/ai-spaces/{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

Represents the name or ID of the AI Space that needs to be copied.

Note: If the AI Space name is provided, then either sourceFolderName or sourceFolderId must also be provided.

–


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 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.

–


Request Body

Parameter Name

Type

Description

Possible Values

Parameter Name

Type

Description

Possible Values

sourceFolderName

String

Name of the folder containing the AI Space. If the AI Space is present in the root directory, specify [Root].

Note: If neither sourceFolderName nor sourceFolderId is provided, the AI Space is treated as a root-level entity by default.

–

sourceFolderId

String

ID of the folder containing the AI Space.

–

targetFolderName

String

Name of the folder where the AI Space will be copied.

–

targetFolderId

String

ID of the folder where the AI Space will be copied.

–

targetSpaceName (Required)

String

New name to assign to the AI Space during the copy operation.

Note: You may provide the same name as the original AI Space if no change is required.

–


Responses

200 Success

{ "code": 0, "message": "AI Space copied successfully." }

Status Code

Description

Status Code

Description

401

Authorization information is missing or invalid.

404

No matching record found.

412

Precondition failed. Required parameter missing.

500

Internal Server Error


Copyright Kyvos, Inc. 2026. All rights reserved.