Skip to main content
POST
Rename Folder
Product: Visual Search Use case: Organize your indexed videos into folders and scope uploads/searches to a folder Host: https://api.memories.ai/serve/api/v1 Auth: Authorization: sk-mavi-... (no Bearer prefix)
Rename an existing folder. Only folders you created can be renamed — the built-in Default folder (-1) and the legacy API folder (-2) cannot.

Prerequisites

Request Example

Uses application/x-www-form-urlencoded — send folder_id and new_name as form fields.
cURL

Parameters

folder_id
integer
required
Id of the folder to rename. Must be > 0 and belong to your account. The Default folder (-1) and legacy API folder (-2) cannot be renamed.
new_name
string
required
New folder name. Maximum 100 characters. Must not collide with an existing folder name in your account.

Response Example

Response Fields

code
string
Business status code. 0000 indicates success.
msg
string
Human-readable status message.
data.folder_id
integer
Identifier of the renamed folder (unchanged).
data.folder_name
string
The new folder name.

Notes & Limits

  • Passing folder_id <= 0 returns an error — the default/virtual folders are not renamable.
  • A folder that does not belong to your account returns Folder does not exist or does not belong to the current user.
  • Renaming to an existing name returns Folder with this name already exists.

Authorizations

Authorization
string
header
required

Body

application/x-www-form-urlencoded
folder_id
integer
required

Folder id to rename. Must be > 0 and belong to your account.

Example:

671631448308117500

new_name
string
required
Maximum string length: 100
Example:

"renamed-project"

Response

200 - application/json

Successful response

code
string
Example:

"0000"

msg
string
Example:

"success"

data
object