curl --request GET 'https://api.voicecheap.ai/v1/openapi.json'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/openapi.json', {
method: 'GET',
headers: {},
redirect: 'manual',
});
console.log(response.status, await response.text());
import os
import requests
response = requests.request(
"GET",
"https://api.voicecheap.ai/v1/openapi.json",
headers={},
timeout=120,
allow_redirects=False,
)
print(response.status_code, response.text)
ディスカバリー
アクションの OpenAPI ドキュメントを取得
すべての顧客向けアクションと入力スキーマを記述した、公開 OpenAPI 3.1 定義を取得します。
GET
/
v1
/
openapi.json
curl --request GET 'https://api.voicecheap.ai/v1/openapi.json'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/openapi.json', {
method: 'GET',
headers: {},
redirect: 'manual',
});
console.log(response.status, await response.text());
import os
import requests
response = requests.request(
"GET",
"https://api.voicecheap.ai/v1/openapi.json",
headers={},
timeout=120,
allow_redirects=False,
)
print(response.status_code, response.text)
すべての顧客向けアクションと入力スキーマを記述した、公開 OpenAPI 3.1 定義を取得します。
GET https://api.voicecheap.ai/v1/openapi.json
認証
なし。このルートはアカウントを認証せず、どのアクションへのアクセス権も付与しません。リクエスト例
このルートに記載されたエンコード方式と認証方法に従ってください。アクション API のエンベロープと冪等性のルールは、アクションの呼び出しにのみ適用されます。curl --request GET 'https://api.voicecheap.ai/v1/openapi.json'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/openapi.json', {
method: 'GET',
headers: {},
redirect: 'manual',
});
console.log(response.status, await response.text());
import os
import requests
response = requests.request(
"GET",
"https://api.voicecheap.ai/v1/openapi.json",
headers={},
timeout=120,
allow_redirects=False,
)
print(response.status_code, response.text)
レスポンス
メタデータの代表的な抜粋です。完全なレスポンスには、登録済みの各アクションのパスも含まれ、JSON リクエストスキーマ、必要なスコープ、変更操作の冪等性ヘッダー、文書化された HTTP の結果が記載されます。HTTP 200
{
"openapi": "3.1.0",
"info": {
"title": "VoiceCheap API",
"version": "1.0.0",
"description": "Public customer actions shared with the VoiceCheap MCP. Existing multipart v1 routes remain documented separately."
},
"servers": [
{
"url": "https://api.voicecheap.ai/v1"
}
],
"security": [
{
"ApiKey": []
},
{
"BearerApiKey": []
}
],
"components": {
"securitySchemes": {
"ApiKey": {
"type": "apiKey",
"in": "header",
"name": "x-api-key"
},
"BearerApiKey": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "VoiceCheap API key"
}
}
}
}
操作の注意事項
- 返される servers[0].url には /v1 が含まれます。ドキュメントのアクションパスは /actions/ で始まるため、/v1 を重ねて追加しないでください。
- これはフィルターされていない全アクションのカタログです。特定の認証情報で利用できるアクションは、認証付きの GET /v1/actions で確認してください。
- 実行時のOpenAPIドキュメントは、アクションのディスパッチのみを対象とします。OAuthルート、/mcp、ディスカバリー自体、既存のマルチパートルートは含みません。
- この読み取りは、月間連携呼び出し回数もアカウントの連携レートカウンターも消費しません。サービスの公開 HTTP 保護は引き続き適用されます。
- 例では本番環境のオリジンを使用しています。本番環境と開発環境を混在させず、選択した環境からメタデータを読み取ってください。
このページは役に立ちましたか？