curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_123"}'
const input = {
projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_project_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_123"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"kind": "project",
"isHistoricalDerived": false,
"summary": {
"title": "Product launch",
"sourceLanguage": "English",
"totals": {
"translationBaseMinutes": 2,
"lipSyncExtraMinutes": 0,
"lipSyncProExtraMinutes": 0,
"lipSyncPro2ExtraMinutes": 0,
"totalChargedMinutes": 2,
"refundedMinutes": 0,
"netUsedMinutes": 2
}
},
"events": [
{
"id": "project_123-project-created",
"type": "project_created",
"timestamp": 1792065540000,
"tone": "neutral"
},
{
"id": "version_123-translation-launched",
"type": "translation_launched",
"timestamp": 1792065600000,
"tone": "neutral",
"minuteDelta": 2,
"relatedRunLabel": "French"
},
{
"id": "version_123-translation-completed",
"type": "translation_completed",
"timestamp": 1792065720000,
"tone": "success",
"isDerived": false,
"relatedRunLabel": "French"
}
]
}
}
사용량 및 활동
프로젝트 사용량 수명 주기 조회
워크스페이스에 있는 프로젝트의 번역 및 립싱크 분량 차감, 환불 및 수명 주기 이벤트를 조회합니다.
POST
/
v1
/
actions
/
usage_project_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_123"}'
const input = {
projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_project_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_123"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"kind": "project",
"isHistoricalDerived": false,
"summary": {
"title": "Product launch",
"sourceLanguage": "English",
"totals": {
"translationBaseMinutes": 2,
"lipSyncExtraMinutes": 0,
"lipSyncProExtraMinutes": 0,
"lipSyncPro2ExtraMinutes": 0,
"totalChargedMinutes": 2,
"refundedMinutes": 0,
"netUsedMinutes": 2
}
},
"events": [
{
"id": "project_123-project-created",
"type": "project_created",
"timestamp": 1792065540000,
"tone": "neutral"
},
{
"id": "version_123-translation-launched",
"type": "translation_launched",
"timestamp": 1792065600000,
"tone": "neutral",
"minuteDelta": 2,
"relatedRunLabel": "French"
},
{
"id": "version_123-translation-completed",
"type": "translation_completed",
"timestamp": 1792065720000,
"tone": "success",
"isDerived": false,
"relatedRunLabel": "French"
}
]
}
}
워크스페이스에 있는 프로젝트의 번역 및 립싱크 분량 차감, 환불 및 수명 주기 이벤트를 조회합니다.
필요한 권한:
POST https://api.voicecheap.ai/v1/actions/usage_project_get
인증 및 권한
string
필수
이 헤더에 VoiceCheap API 키를 전달하세요. 동일한 API 키를 사용하는 Authorization: Bearer도 지원합니다. OAuth 액세스 토큰은 MCP에서만 허용되며, 이
REST 엔드포인트에서는 사용할 수 없습니다.
usage:read.
활성 유료 구독이 필요합니다. 권한은 팀 역할, 리소스 소유권, 미디어 크레딧 또는 요금제 한도를 변경하지 않습니다.
매개변수
string
필수
텍스트 값입니다.최소 길이: 1. 최대 길이: 200. 패턴:
^[^/]+$.전체 입력 스키마
전체 입력 스키마
아래 JSON Schema는 검색을 통해 제공되는 정확한 필드 이름, 중첩 유형, 기본값, 범위 및 허용값을 유지합니다. 추가적인 필드 간 규칙은 작업 참고 사항에 나와 있습니다.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
요청 예제
예제의 리소스 식별자와 미디어 키를 계정에서 반환된 값으로 바꾸세요. 동일한 변경 작업을 재시도할 때는 요청 식별자를 유지하세요.curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_project_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_123"}'
const input = {
projectId: 'project_123',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/usage_project_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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/usage_project_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_123"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
응답
성공한 첫 실행은 작업 결과를 data 아래에 포함하여 HTTP 200을 반환합니다. 재전송 시에는 저장된 요청 상태를 대신 반환할 수 있습니다. 예제는 지원되는 응답 중 하나를 보여주며 모든 선택 필드를 포함하지는 않습니다. 활성 워크스페이스에서 프로젝트의 여러 번역 실행에 걸친 프로젝트 전체 분 합계와 수명 주기 이벤트를 반환합니다.{
"data": {
"kind": "project",
"isHistoricalDerived": false,
"summary": {
"title": "Product launch",
"sourceLanguage": "English",
"totals": {
"translationBaseMinutes": 2,
"lipSyncExtraMinutes": 0,
"lipSyncProExtraMinutes": 0,
"lipSyncPro2ExtraMinutes": 0,
"totalChargedMinutes": 2,
"refundedMinutes": 0,
"netUsedMinutes": 2
}
},
"events": [
{
"id": "project_123-project-created",
"type": "project_created",
"timestamp": 1792065540000,
"tone": "neutral"
},
{
"id": "version_123-translation-launched",
"type": "translation_launched",
"timestamp": 1792065600000,
"tone": "neutral",
"minuteDelta": 2,
"relatedRunLabel": "French"
},
{
"id": "version_123-translation-completed",
"type": "translation_completed",
"timestamp": 1792065720000,
"tone": "success",
"isDerived": false,
"relatedRunLabel": "French"
}
]
}
}
결과 필드
| 필드 | 설명 |
|---|---|
data.kind | translation 또는 project입니다. |
data.isHistoricalDerived | 하나 이상의 사용량 세부 정보가 과거 데이터에서 도출되었는지 여부입니다. |
data.summary.title | 프로젝트 표시 이름입니다. |
data.summary.sourceLanguage | 사용 가능한 경우 형식이 적용된 원본 언어 레이블입니다. |
data.summary.targetLanguage | 번역 수명 주기의 대상 언어이며 프로젝트 수명 주기에서는 생략됩니다. |
data.summary.translationStatus | 번역 수명 주기의 번역 상태입니다. 프로젝트 수명 주기에는 포함되지 않습니다. |
data.summary.lipSyncStatus | 번역 수명 주기의 립싱크 상태입니다. 프로젝트 수명 주기에서는 생략됩니다. |
data.summary.totals.translationBaseMinutes | 일치하는 행 전체에 걸쳐 청구된 기본 번역 분 수입니다. |
data.summary.totals.lipSyncExtraMinutes | 추가로 청구된 Standard 립싱크 분 단위 사용량입니다. |
data.summary.totals.lipSyncProExtraMinutes | 청구된 추가 Pro 립싱크 분입니다. |
data.summary.totals.lipSyncPro2ExtraMinutes | 추가로 차감된 Pro 2 립싱크 분량입니다. |
data.summary.totals.totalChargedMinutes | 환불 전 총 차감 분량입니다. |
data.summary.totals.refundedMinutes | 환불된 분량입니다. |
data.summary.totals.netUsedMinutes | 차감된 분량에서 환불된 분량을 뺀 값입니다. |
data.events | 타임스탬프순 수명 주기 이벤트입니다. 타임스탬프가 없는 이벤트는 타임스탬프가 있는 이벤트 뒤에 옵니다. |
data.events[].id | 보고된 수명 주기 단계의 고정된 이벤트 식별자입니다. |
data.events[].type | project_created, translation_launched, translation_completed 또는 lip_sync_refunded와 같은 이벤트 유형입니다. |
data.events[].timestamp | 선택적인 밀리초 단위 이벤트 타임스탬프입니다. |
data.events[].tone | neutral, success, warning 또는 danger입니다. |
data.events[].relatedRunLabel | 프로젝트 수명 주기 이벤트의 선택적인 대상 언어 및 실행 레이블입니다. |
data.events[].minuteDelta | 양수로 표시한 차감 분량 또는 음수로 표시한 환불 분량이며, 선택 사항입니다. |
data.events[].isDerived | 과거 데이터로 재구성한 이벤트임을 나타내는 선택적인 플래그입니다. |
작업 참고 사항
- 프로젝트는 활성 워크스페이스에 사용량 행이 하나 이상 있어야 합니다. 사용량 행이 없는 프로젝트는 오류를 반환합니다.
- 요약은 프로젝트 전체를 다루며 단일 targetLanguage, translationStatus 및 lipSyncStatus를 포함하지 않습니다. 해당되는 경우 개별 이벤트에 대상 언어/실행 라벨이 포함됩니다.
- 이벤트에는 원시 처리 오류 메시지와 이벤트 표시 라벨이 생략됩니다.
사용량
성공한 호출마다 월간 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 | 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 | 서버가 다시 시작 중입니다. 잠시 후 재시도하고, 변경 작업의 경우 동일한 요청 식별자를 유지하세요. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["usage:read"]
}
}
이 페이지가 도움이 되었나요?

