APIリファレンス

APIキーの取得

GPUnex APIを使用すると、Webダッシュボードを使用せずにGPUインスタンスの管理、残高の確認、ワークフローの自動化が可能です。APIリクエストを行う前に、APIキーを生成する必要があります。

1. GPUnexアカウントにログインし、プロフィールページまたはダッシュボードの設定パネルに移動します。

2. APIキーセクションを開きます。 アカウント設定内のAPIキータブまたはカードを探してください。

3. 「新しいAPIキーを作成」をクリックします。 キーにわかりやすい名前を付けるよう求められます。キーの用途を識別できる意味のある名前を選んでください — 例えば、「本番サーバー」、「CI/CDパイプライン」、「ローカル開発」などです。これにより、後で複数のキーを管理しやすくなります。

4. APIキーをすぐにコピーしてください。 キーが生成されると、一度だけ表示されます。コピーしてパスワードマネージャーや暗号化されたシークレットボルトなどの安全な場所に保管してください。このステップの後、完全なキーを再表示することはできません。

5. キーのスコープと取り消しについて理解しましょう。 各APIキーはアカウントにスコープされ、アカウントの権限を継承します。異なるアプリケーションや環境用に複数のキーを作成できます。キーが侵害された場合や不要になった場合は、APIキーセクションからいつでも取り消すことができます。キーの取り消しは即座に永久的に行われ — そのキーを使用するすべてのリクエストが拒否されます。

認証

GPUnex APIへのすべてのリクエストには、Bearerトークンスキームを使用したAPIキーを含むAuthorizationヘッダーが必要です。

ヘッダー形式：

Authorization: Bearer YOUR_API_KEY

APIキーが欠落、無効、または取り消されている場合、APIは401 Unauthorizedレスポンスを返します：

{
  "error": "unauthorized",
  "message": "Invalid or missing API key. Please check your Authorization header."
}

すべてのリクエストにキーを含めるようにしてください。APIはセッションベースの認証やCookieベースの認証をサポートしていません。

主要エンドポイント

GPUnex APIはRESTfulリソースを中心に構成されています。すべてのエンドポイントはベースURL https://api.gpunex.com/v1 を使用します。以下は利用可能な主要エンドポイントの概要です。

すべてのレスポンスはJSON形式で返されます。成功したリクエストは、GETリクエストに対して200 OKステータスコード、リソースを作成するPOSTリクエストに対して201 Createdステータスコードを返します。

例：インスタンスの作成

新しいGPUインスタンスを作成するには、希望の設定を指定するJSONボディを含むPOSTリクエストを/v1/instancesに送信します。

リクエスト：

リクエストボディのパラメータ：

レスポンス例（201 Created）：

{
  "id": "inst_7f3a9b2c4d1e",
  "status": "provisioning",
  "gpu_model": "A100_80GB",
  "framework": "pytorch-2.3",
  "region": "us-east-1",
  "ssh_command": null,
  "hourly_rate": "1.89",
  "currency": "USDC",
  "created_at": "2026-02-15T14:32:07Z"
}

インスタンスの初期ステータスはprovisioningです。GPUが割り当てられ環境が準備されると、ステータスはrunningに変わり、ssh_commandフィールドに接続文字列が設定されます。プロビジョニングには通常、可用性に応じて30秒から2分かかります。

例：インスタンスのステータス確認

インスタンスを作成した後、IDを指定してインスタンスエンドポイントにクエリを送ることで、いつでも現在のステータスを確認できます。

リクエスト：

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.gpunex.com/v1/instances/inst_7f3a9b2c4d1e

レスポンス例（200 OK）：

{
  "id": "inst_7f3a9b2c4d1e",
  "status": "running",
  "gpu_model": "A100_80GB",
  "framework": "pytorch-2.3",
  "region": "us-east-1",
  "ssh_command": "ssh [email protected] -p 2222",
  "ip_address": "203.0.113.42",
  "hourly_rate": "1.89",
  "currency": "USDC",
  "uptime_seconds": 3847,
  "total_cost": "2.02",
  "created_at": "2026-02-15T14:32:07Z",
  "started_at": "2026-02-15T14:33:15Z"
}

ステータス値：

レート制限とベストプラクティス

レート制限

GPUnex APIは、公平な使用とプラットフォームの安定性を確保するためにレート制限を適用しています。現在の制限は以下の通りです：

• 一般エンドポイント： APIキーあたり毎分120リクエスト。
• インスタンス作成： APIキーあたり毎分10リクエスト。
• 残高および読み取り専用エンドポイント： APIキーあたり毎分300リクエスト。

レート制限を超えると、APIは429 Too Many Requestsレスポンスと、再試行までの待機秒数を示すRetry-Afterヘッダーを返します。

{
  "error": "rate_limit_exceeded",
  "message": "Too many requests. Please retry after 12 seconds.",
  "retry_after": 12
}

ベストプラクティス

インテグレーションを安全で信頼性の高いものに保つために、以下のガイドラインに従ってください。

1. クライアントサイドのコードにAPIキーを公開しないでください。 ブラウザで実行されるJavaScript、モバイルアプリのソースコード、または公開アクセス可能なリポジトリにAPIキーを埋め込まないでください。APIキーはエンドユーザーが検査できないサーバーサイドアプリケーションでのみ使用してください。

2. 環境変数を使用してください。 APIキーをソースファイルにハードコーディングするのではなく、環境変数に保存してください。例：

   export GPUNEX_API_KEY="your_api_key_here"

   コード内で参照する場合：

   curl -H "Authorization: Bearer $GPUNEX_API_KEY" https://api.gpunex.com/v1/instances

3. キーを定期的にローテーションしてください。 セキュリティのベストプラクティスとして、90日ごとに新しいAPIキーを生成し、古いキーを取り消してください。これにより、キーが誤って漏洩した場合の影響を制限できます。

4. 環境ごとに別のキーを使用してください。 開発、ステージング、本番環境用に個別のAPIキーを作成してください。こうすることで、一つのキーを取り消しても他の環境に影響しません。

5. エラーを適切に処理してください。 アプリケーションでは常にHTTPステータスコードを確認してください。429および5xxレスポンスに対しては指数バックオフ付きのリトライロジックを実装してください。429以外の4xxエラーはリトライしないでください — これらはリクエスト自体の問題を示しています。

6. 使用状況を監視してください。 API呼び出し量とインスタンスの支出を把握してください。/v1/balanceエンドポイントを使用してUSDC残高をプログラムで監視し、残高がしきい値を下回った場合のアラートを設定してください。