curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"query":"Product","limit":20,"offset":0,"originalLanguage":"fr","targetLanguage":"english","status":"translated","sort":"newestFirst"}'
const input = {
query: 'Product',
limit: 20,
offset: 0,
originalLanguage: 'fr',
targetLanguage: 'english',
status: 'translated',
sort: 'newestFirst',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_list', {
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/projects_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"query": "Product", "limit": 20, "offset": 0, "originalLanguage": "fr", "targetLanguage": "english", "status": "translated", "sort": "newestFirst"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projects": [
{
"projectId": "project_launch_2026",
"projectName": "Product launch",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progressStep": "done",
"folderId": null
}
],
"offset": 0,
"limit": 20,
"nextOffset": null
}
}
プロジェクト
プロジェクトを一覧表示または検索
アクセス可能なプロジェクトを、ページ分割、名前検索、言語・状態フィルター付きで一覧表示します。チームのゲストに表示されるのは、自分が API で作成したプロジェクトのみです。
POST
/
v1
/
actions
/
projects_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"query":"Product","limit":20,"offset":0,"originalLanguage":"fr","targetLanguage":"english","status":"translated","sort":"newestFirst"}'
const input = {
query: 'Product',
limit: 20,
offset: 0,
originalLanguage: 'fr',
targetLanguage: 'english',
status: 'translated',
sort: 'newestFirst',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_list', {
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/projects_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"query": "Product", "limit": 20, "offset": 0, "originalLanguage": "fr", "targetLanguage": "english", "status": "translated", "sort": "newestFirst"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projects": [
{
"projectId": "project_launch_2026",
"projectName": "Product launch",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progressStep": "done",
"folderId": null
}
],
"offset": 0,
"limit": 20,
"nextOffset": null
}
}
アクセス可能なプロジェクトを、ページ分割、名前検索、言語・状態フィルター付きで一覧表示します。チームのゲストに表示されるのは、自分が API で作成したプロジェクトのみです。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/projects_list
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
projects:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
テキスト値。最小文字数: 1. 最大文字数: 200.
integer
整数値。最小値: 0. 最大値: 100000. デフォルト値: 0.
integer
整数値。最小値: 1. 最大値: 50. デフォルト値: 20.
string
テキスト値。許容値: “afrikaans”, “albanian”, “amharic”, “arabic”, “armenian”, “assamese”, “azerbaijani”, “basque”, “belarusian”, “bengali”, “bosnian”, “bulgarian”, “catalan”, “croatian”, “czech”, “danish”, “dutch”, “english”, “british english”, “estonian”, “finnish”, “french”, “french canadian”, “galician”, “german”, “greek”, “gujarati”, “hebrew”, “hindi”, “hungarian”, “icelandic”, “indonesian”, “irish”, “italian”, “japanese”, “kannada”, “kazakh”, “khmer”, “korean”, “lao”, “latvian”, “lithuanian”, “macedonian”, “malay”, “malayalam”, “mandarin”, “marathi”, “mongolian”, “nepali”, “norwegian”, “persian”, “polish”, “portuguese”, “brazilian portuguese”, “pt_brazil”, “punjabi”, “romanian”, “russian”, “serbian”, “slovak”, “slovenian”, “spanish”, “swahili”, “swedish”, “tagalog”, “tamil”, “telugu”, “thai”, “turkish”, “ukrainian”, “urdu”, “vietnamese”, “welsh”, “yoruba”, “zulu”.
string
テキスト値。許容値: “af”, “sq”, “am”, “ar”, “hy”, “as”, “ast”, “az”, “ba”, “eu”, “be”, “bn”, “bs”, “br”, “bg”, “my”, “ca”, “ceb”, “zh”, “hr”, “cs”, “da”, “nl”, “en”, “eo”, “at”, “et”, “fil”, “fo”, “fi”, “fr”, “fr-CA”, “fy”, “ff”, “gd”, “gl”, “lg”, “ka”, “de”, “el”, “gu”, “ht”, “ha”, “haw”, “he”, “hi”, “hu”, “is”, “ig”, “ilo”, “id”, “ia”, “ga”, “it”, “ja”, “jv”, “kea”, “kn”, “kk”, “km”, “kur”, “kir”, “ko”, “lo”, “la”, “luo”, “lv”, “lb”, “ln”, “lt”, “mk”, “mg”, “ms”, “ml”, “mt”, “mi”, “mr”, “mo”, “mn”, “ne”, “no”, “nn”, “nso”, “nya”, “oc”, “or”, “pa”, “ps”, “fa”, “pl”, “pt”, “ro”, “ru”, “sa”, “sr”, “sn”, “sd”, “si”, “sk”, “sl”, “so”, “es”, “su”, “sw”, “ss”, “sv”, “tl”, “tg”, “ta”, “tt”, “te”, “th”, “bo”, “tn”, “tr”, “tk”, “ug”, “uk”, “umb”, “ur”, “uz”, “vi”, “cy”, “wo”, “xh”, “yi”, “yo”, “zu”, “cmn”, “yue”, “en-GB”, “en-US”, “en-AU”, “auto-detect”.
string
テキスト値。許容値: “awaitingProofreading”, “translated”, “failed”.
string
テキスト値。許容値: “newestFirst”, “oldestFirst”. デフォルト値: “newestFirst”.
string
テキスト値。最小文字数: 1. 最大文字数: 200. パターン:
^[^/\\]+$.完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"query": {
"type": "string",
"minLength": 1,
"maxLength": 200
},
"offset": {
"default": 0,
"type": "integer",
"minimum": 0,
"maximum": 100000
},
"limit": {
"default": 20,
"type": "integer",
"minimum": 1,
"maximum": 50
},
"targetLanguage": {
"type": "string",
"enum": [
"afrikaans",
"albanian",
"amharic",
"arabic",
"armenian",
"assamese",
"azerbaijani",
"basque",
"belarusian",
"bengali",
"bosnian",
"bulgarian",
"catalan",
"croatian",
"czech",
"danish",
"dutch",
"english",
"british english",
"estonian",
"finnish",
"french",
"french canadian",
"galician",
"german",
"greek",
"gujarati",
"hebrew",
"hindi",
"hungarian",
"icelandic",
"indonesian",
"irish",
"italian",
"japanese",
"kannada",
"kazakh",
"khmer",
"korean",
"lao",
"latvian",
"lithuanian",
"macedonian",
"malay",
"malayalam",
"mandarin",
"marathi",
"mongolian",
"nepali",
"norwegian",
"persian",
"polish",
"portuguese",
"brazilian portuguese",
"pt_brazil",
"punjabi",
"romanian",
"russian",
"serbian",
"slovak",
"slovenian",
"spanish",
"swahili",
"swedish",
"tagalog",
"tamil",
"telugu",
"thai",
"turkish",
"ukrainian",
"urdu",
"vietnamese",
"welsh",
"yoruba",
"zulu"
]
},
"originalLanguage": {
"type": "string",
"enum": [
"af",
"sq",
"am",
"ar",
"hy",
"as",
"ast",
"az",
"ba",
"eu",
"be",
"bn",
"bs",
"br",
"bg",
"my",
"ca",
"ceb",
"zh",
"hr",
"cs",
"da",
"nl",
"en",
"eo",
"at",
"et",
"fil",
"fo",
"fi",
"fr",
"fr-CA",
"fy",
"ff",
"gd",
"gl",
"lg",
"ka",
"de",
"el",
"gu",
"ht",
"ha",
"haw",
"he",
"hi",
"hu",
"is",
"ig",
"ilo",
"id",
"ia",
"ga",
"it",
"ja",
"jv",
"kea",
"kn",
"kk",
"km",
"kur",
"kir",
"ko",
"lo",
"la",
"luo",
"lv",
"lb",
"ln",
"lt",
"mk",
"mg",
"ms",
"ml",
"mt",
"mi",
"mr",
"mo",
"mn",
"ne",
"no",
"nn",
"nso",
"nya",
"oc",
"or",
"pa",
"ps",
"fa",
"pl",
"pt",
"ro",
"ru",
"sa",
"sr",
"sn",
"sd",
"si",
"sk",
"sl",
"so",
"es",
"su",
"sw",
"ss",
"sv",
"tl",
"tg",
"ta",
"tt",
"te",
"th",
"bo",
"tn",
"tr",
"tk",
"ug",
"uk",
"umb",
"ur",
"uz",
"vi",
"cy",
"wo",
"xh",
"yi",
"yo",
"zu",
"cmn",
"yue",
"en-GB",
"en-US",
"en-AU",
"auto-detect"
]
},
"status": {
"type": "string",
"enum": ["awaitingProofreading", "translated", "failed"]
},
"sort": {
"default": "newestFirst",
"type": "string",
"enum": ["newestFirst", "oldestFirst"]
},
"folderId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"query":"Product","limit":20,"offset":0,"originalLanguage":"fr","targetLanguage":"english","status":"translated","sort":"newestFirst"}'
const input = {
query: 'Product',
limit: 20,
offset: 0,
originalLanguage: 'fr',
targetLanguage: 'english',
status: 'translated',
sort: 'newestFirst',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_list', {
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/projects_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"query": "Product", "limit": 20, "offset": 0, "originalLanguage": "fr", "targetLanguage": "english", "status": "translated", "sort": "newestFirst"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 アクセス可能なプロジェクト概要を1ページ分と、オフセットページネーションのメタデータを返します。{
"data": {
"projects": [
{
"projectId": "project_launch_2026",
"projectName": "Product launch",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progressStep": "done",
"folderId": null
}
],
"offset": 0,
"limit": 20,
"nextOffset": null
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.projects | 公開用プロジェクト概要のページ。 |
data.offset | 指定した開始オフセット。 |
data.limit | リクエストしたページサイズ。 |
data.nextOffset | 取得したページが上限件数に達している場合は offset + limit、それ以外は null。 |
data.projects[].duration | 保存済みの長さ(秒)。 |
data.projects[].createdAt | プロジェクトの作成時刻(Unixミリ秒)。 |
data.projects[].folderId | フォルダー識別子、または null。 |
操作の注意事項
- offset のデフォルトは 0、limit は 20(最大 50)、sort は newestFirst です。query はプロジェクト名を検索し、folderId、ソース言語、翻訳先言語、status は一覧を絞り込みます。
- 返されるプロジェクトのフィールドは projectId、projectName、originalLanguage、targetLanguages、duration、createdAt、progressStep、folderId です。未保存の任意フィールドは省略される場合があります。targetLanguages のデフォルトは []、duration は0、folderId は null です。
- nextOffset は、基盤データから取得したページに limit 件の項目が含まれる場合に設定されます。総件数を示すものではなく、アクセス可能な次の結果の存在も保証しません。
- チームゲストが閲覧できるのは、同じチーム内で、そのメンバー自身が API 経由で作成したプロジェクトのみです。絞り込みにより、nextOffset があっても projects 配列の件数が少なくなる場合があります。
- originalLanguage には fr や en などの元言語コード(対応する場合は auto-detect)を指定します。targetLanguage には english などの対応する翻訳先言語名を指定します。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | VALIDATION_ERROR | スキーマに従って入力を修正してください。無効な値や整合性のない値は実行前に拒否されます。 |
| 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_OWNER_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": ["projects:read"]
}
}
このページは役に立ちましたか?

