> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 更新文件夹

> 重命名文件夹，或更新应用于其中项目的翻译指令。

重命名文件夹，或更新应用于其中项目的翻译指令。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/folders_update
```

## 身份验证和权限

<ParamField header="x-api-key" type="string" required>
  在此请求头中发送 VoiceCheap API 密钥。也支持通过 Authorization: Bearer 发送同一 API 密钥。OAuth 访问令牌仅适用于 MCP，此 REST 端点不接受 OAuth
  访问令牌。
</ParamField>

所需权限: `folders:write`.

需要有效的付费订阅。权限不会改变团队角色、资源归属、媒体额度或套餐限制。

## 参数

<ParamField body="requestId" type="string">
  在传输层可选：如果省略，服务器会在验证前注入标识符。请自行提供稳定的 UUID v4，以便在响应丢失后安全恢复。

  格式: "uuid". 匹配模式: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
</ParamField>

<ParamField body="folderId" type="string" required>
  文本值。

  最小长度: 1. 最大长度: 200. 匹配模式: `^[^/]+$`.
</ParamField>

<ParamField body="folderName" type="string">
  文本值。

  最小长度: 1. 最大长度: 60.
</ParamField>

<ParamField body="translationInstructions" type="string">
  文本值。

  最大长度: 1000.
</ParamField>

<Accordion title="完整输入架构">
  以下 JSON Schema 保留了发现接口公开的确切字段名、嵌套类型、默认值、范围和可接受值。其他跨字段规则列于操作说明中。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "requestId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "folderId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/]+$"
      },
      "folderName": {
        "type": "string",
        "minLength": 1,
        "maxLength": 60
      },
      "translationInstructions": {
        "type": "string",
        "maxLength": 1000
      }
    },
    "required": ["folderId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 幂等性

为每次修改操作在 requestId 或 Idempotency-Key HTTP 请求头中提供 UUID v4。网络故障后，请使用相同标识符和完全相同的参数重试。如果同时提供这两个值，它们必须一致。重放已保存的请求不会重复执行操作，也不会再次扣除月度调用次数。失败或中断的请求不会自动重新执行。

对于每次修改操作，如果重试时发现同一请求仍在运行，即使首次执行通常为同步操作，也可能返回 HTTP 202。如果执行已完成但 resultStored 为 false，重试会返回 HTTP 200 和已保存的请求状态，而非原始结果。请通过对应领域的历史记录、结果或下载操作获取输出。

## 请求示例

请将示例资源标识符和媒体键替换为账户返回的值。重试同一次修改操作时，请保持请求标识符不变。

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_update' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","folderName":"Product videos","translationInstructions":"Keep product names unchanged."}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
    folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
    folderName: 'Product videos',
    translationInstructions: 'Keep product names unchanged.',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_update', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.VOICECHEAP_API_KEY,
      'Content-Type': 'application/json',
    },
    body: JSON.stringify(input),
  });
  const body = await response.json();
  if (!response.ok) throw new Error(body.code + ': ' + body.message);
  console.log(body);
  ```

  ```python Python theme={null}
  import os
  import requests

  response = requests.post(
      "https://api.voicecheap.ai/v1/actions/folders_update",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "folderName": "Product videos", "translationInstructions": "Keep product names unchanged."},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 响应

首次执行成功时返回 HTTP 200，操作结果位于 data 下。重放请求时可能改为返回已保存的请求状态。示例展示了一种支持的响应，并未包含所有可选字段。

保存新名称或翻译说明后，返回文件夹。

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
      "folderName": "Product videos",
      "projectIds": [
        "project_123"
      ],
      "dateCreated": 1792065600000,
      "translationInstructions": "Keep product names unchanged."
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
      "operation": "folders_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
      "operation": "folders_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```
</ResponseExample>

## 结果字段

| 字段 | 说明 |
| - | - |
| `data.folderId` | 文件夹标识符。后续文件夹操作请使用返回的值。 |
| `data.folderName` | 当前文件夹名称。 |
| `data.projectIds` | 分配到此文件夹且可访问的项目标识符。 |
| `data.dateCreated` | 文件夹创建时间，以 Unix 毫秒时间戳表示。 |
| `data.translationInstructions` | 文件夹上保存的翻译说明；空字符串表示无说明。 |

## 恢复并轮询此请求

即使连接丢失，也应使用同一标识符。如果 resultStored 为 false，请通过相应的历史记录、结果或下载操作获取输出。切勿仅为查看进度而启动第二次生成。

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"folders_update"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "folders_update",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
      "folderName": "Product videos",
      "projectIds": ["project_123"],
      "dateCreated": 1792065600000,
      "translationInstructions": "Keep product names unchanged."
    }
  }
}
```

## 操作说明

* 请提供 folderName、translationInstructions，或同时提供两者。
* 文件夹名称包含 1–60 个字符；翻译指令最多包含 1,000 个字符。指令保存前会去除首尾空白。
* 重命名也会更新分配到此文件夹的项目中显示的文件夹名称。后续翻译内容会读取文件夹中的指令。
* 对于团队访客，projectIds 和请求的指标仅包含其本人在当前团队中通过 API 创建的项目。已保存的结果和重放执行相同的项目访问检查。
* 团队访客只有在能够访问所有已分配项目时，才可重命名文件夹、更改其指令或删除文件夹。否则，操作会在进行任何更改之前返回 FOLDER\_PROJECT\_ACCESS\_DENIED。

## 用量

每次成功调用消耗一次月度 API/MCP 调用额度。媒体额度和操作本身的生成限额也适用。

## 错误

| HTTP 状态 | 代码 | 含义或恢复方式 |
| - | - | - |
| 400 | `BAD_REQUEST` | 未找到文件夹或所需的工作区账户。 |
| 400 | `CREDENTIAL_IN_QUERY` | 凭证通过 access\_token 或 api\_key 查询参数提供。请在标头中发送凭证。 |
| 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key 请求头必须与请求体中的 requestId 字段一致。 |
| 400 | `INVALID_REQUEST_ID` | 请在 requestId 或 Idempotency-Key 中提供 UUID v4。 |
| 400 | `VALIDATION_ERROR` | JSON 对象包含不受支持的字段、无效值，或缺少必需参数。 |
| 401 | `API_KEY_EXPIRED` | API 密钥已过期。 |
| 401 | `INVALID_API_KEY` | 请提供有效且未过期的 API 密钥。 |
| 401 | `INVALID_CREDENTIAL` | Authorization 标头格式错误或与 x-api-key 冲突。 |
| 401 | `MISSING_CREDENTIAL` | 未提供可用的请求头凭据，或其长度超过 4096 个字符。 |
| 401 | `UNAUTHORIZED` | 该文件夹不属于当前工作区。 |
| 401 | `USER_NOT_FOUND` | 该凭据对应的账户已不存在。 |
| 403 | `ACCOUNT_UNAVAILABLE` | 调用者账户或计费账户不可用，或正在删除。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 此凭据对应的用户属于多个团队，因此计费上下文不明确。 |
| 403 | `FOLDER_PROJECT_ACCESS_DENIED` | 此文件夹包含您无法修改的项目。 |
| 403 | `INSUFFICIENT_SCOPE` | 请授予全部所需权限，或选择其他凭据。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 无法验证该账户的集成限制。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 请使用有效的付费订阅。 |
| 403 | `TEAM_MEMBERSHIP_INVALID` | 账户当前的团队成员关系与此连接的工作区不匹配。请刷新成员关系并重新连接。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 找不到实际生效的团队所有者账户。 |
| 404 | `ACCOUNT_NOT_FOUND` | 找不到账户或当前工作区账户。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | 此账户已有 10 个集成操作正在运行。请先轮询现有请求，再启动另一个操作。 |
| 409 | `IDEMPOTENCY_CONFLICT` | 只有操作和参数完全相同时，才能复用标识符。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 请等待月度额度重置，或更改套餐。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | 如果提供了 Retry-After，请等待其指定的时间，并采用退避重试。 |
| 500 | `INTERNAL_ERROR` | 在决定是否重试修改操作前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `ACTION_RESULT_UNAVAILABLE` | 操作已执行，但未能保存结果。在启动新的生成前，请检查已保存的请求状态和资源历史记录。 |
| 503 | `SERVER_RESTARTING` | 服务器正在重启。请稍后重试；对于修改操作，请保持请求标识符不变。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["folders:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.