> ## 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.
# 폴더 조회
> 활성 워크스페이스에 있는 폴더의 이름, 번역 지침, 프로젝트 ID 및 선택적 프로젝트 지표를 조회합니다.
활성 워크스페이스에 있는 폴더의 이름, 번역 지침, 프로젝트 ID 및 선택적 프로젝트 지표를 조회합니다.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/folders_get
```
## 인증 및 권한
이 헤더에 VoiceCheap API 키를 전달하세요. 동일한 API 키를 사용하는 Authorization: Bearer도 지원합니다. OAuth 액세스 토큰은 MCP에서만 허용되며, 이
REST 엔드포인트에서는 사용할 수 없습니다.
필요한 권한: `folders:read`.
활성 유료 구독이 필요합니다. 권한은 팀 역할, 리소스 소유권, 미디어 크레딧 또는 요금제 한도를 변경하지 않습니다.
## 매개변수
텍스트 값입니다.
최소 길이: 1. 최대 길이: 200. 패턴: `^[^/]+$`.
불리언 값입니다.
기본값: false.
아래 JSON Schema는 검색을 통해 제공되는 정확한 필드 이름, 중첩 유형, 기본값, 범위 및 허용값을 유지합니다. 추가적인 필드 간 규칙은 작업 참고 사항에 나와 있습니다.
```json theme={null}
{
"type": "object",
"properties": {
"folderId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
},
"includeProjectMetrics": {
"default": false,
"type": "boolean"
}
},
"required": ["folderId"],
"additionalProperties": false
}
```
## 요청 예제
예제의 리소스 식별자와 미디어 키를 계정에서 반환된 값으로 바꾸세요. 동일한 변경 작업을 재시도할 때는 요청 식별자를 유지하세요.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/folders_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","includeProjectMetrics":true}'
```
```javascript JavaScript theme={null}
const input = {
folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
includeProjectMetrics: true,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_get', {
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_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "includeProjectMetrics": True},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## 응답
성공한 첫 실행은 작업 결과를 data 아래에 포함하여 HTTP 200을 반환합니다. 재전송 시에는 저장된 요청 상태를 대신 반환할 수 있습니다. 예제는 지원되는 응답 중 하나를 보여주며 모든 선택 필드를 포함하지는 않습니다.
폴더 세부 정보를 반환하며, 요청한 경우 현재 프로젝트 지표를 포함합니다.
```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.",
"projectMetrics": {
"projectsCount": 1,
"totalDurationSeconds": 120,
"translatedProjectsCount": 1,
"translationsInProgressProjectsCount": 0,
"awaitingProofreadingProjectsCount": 0
}
}
}
```
## 결과 필드
| 필드 | 설명 |
| - | - |
| `data.folderId` | 폴더 식별자입니다. 이후 폴더 액션에서 반환된 값을 사용하세요. |
| `data.folderName` | 현재 폴더 이름입니다. |
| `data.projectIds` | 이 폴더에 할당된 접근 가능한 프로젝트의 식별자입니다. |
| `data.dateCreated` | 폴더 생성 시각을 나타내는 밀리초 단위 Unix 타임스탬프입니다. |
| `data.translationInstructions` | 폴더에 저장된 번역 지침입니다. 빈 문자열은 지침이 없음을 뜻합니다. |
| `data.projectMetrics` | 지표를 요청한 경우에 포함됩니다. |
| `data.projectMetrics.projectsCount` | projectIds에 포함된 접근 가능한 프로젝트 수입니다. |
| `data.projectMetrics.totalDurationSeconds` | 원본의 합산 길이로, 초 단위입니다. |
| `data.projectMetrics.translatedProjectsCount` | 모든 대상 언어에서 번역 완료로 표시된 프로젝트입니다. |
| `data.projectMetrics.translationsInProgressProjectsCount` | 번역이 진행 중인 프로젝트입니다. |
| `data.projectMetrics.awaitingProofreadingProjectsCount` | 교정 대기 중인 프로젝트입니다. |
## 작업 참고 사항
* includeProjectMetrics의 기본값은 false입니다. 요청하지 않으면 지표가 포함되지 않습니다.
* 팀 게스트의 경우 projectIds와 요청한 지표에는 활성 팀에서 본인이 API를 통해 만든 프로젝트만 포함됩니다. 저장된 결과와 재실행에도 동일한 프로젝트 접근 검사가 적용됩니다.
## 사용량
성공한 호출마다 월간 API/MCP 호출 1회가 차감됩니다. 미디어 크레딧과 해당 작업의 생성 허용량도 적용됩니다.
## 오류
| HTTP 상태 | 코드 | 의미 또는 복구 방법 |
| - | - | - |
| 400 | `BAD_REQUEST` | 폴더 또는 필요한 워크스페이스 계정을 찾을 수 없습니다. |
| 400 | `CREDENTIAL_IN_QUERY` | 자격 증명이 access\_token 또는 api\_key 쿼리 매개변수로 제공되었습니다. 자격 증명은 헤더로 보내세요. |
| 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 | `AMBIGUOUS_TEAM_API_KEY` | 이 자격 증명의 사용자가 둘 이상의 팀에 속해 있어 청구 컨텍스트가 모호합니다. |
| 403 | `INSUFFICIENT_SCOPE` | 필요한 모든 권한을 부여하거나 다른 자격 증명을 사용하세요. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | 계정의 통합 한도를 확인할 수 없습니다. |
| 403 | `SUBSCRIPTION_REQUIRED` | 활성 유료 구독을 사용하세요. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | 계정의 현재 팀 멤버십이 이 연결의 워크스페이스와 일치하지 않습니다. 멤버십을 새로 조회하고 다시 연결하세요. |
| 403 | `TEAM_OWNER_NOT_FOUND` | 실제로 적용되는 팀 소유자 계정을 찾을 수 없습니다. |
| 404 | `ACCOUNT_NOT_FOUND` | 계정 또는 활성 워크스페이스 계정을 찾을 수 없습니다. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 월간 한도가 초기화될 때까지 기다리거나 요금제를 변경하세요. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After가 있으면 지정된 시간만큼 기다리고 백오프를 적용하세요. |
| 500 | `INTERNAL_ERROR` | 변경 작업을 재시도하기로 결정하기 전에 저장된 요청 상태와 리소스 기록을 확인하세요. |
| 503 | `SERVER_RESTARTING` | 서버가 다시 시작 중입니다. 잠시 후 재시도하고, 변경 작업의 경우 동일한 요청 식별자를 유지하세요. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["folders:read"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.