メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

​
概要

Qoder Cloud Agents API は PAT（Personal Access Token、個人アクセストークン） を使用して認証します。すべての API リクエストは、HTTP ヘッダーに有効な PAT を含める必要があります。

​
PAT の取得方法

  1. Qoder コンソール にログインします。
  2. 設定 → API トークン ページに移動します。
  3. トークンの作成 をクリックし、名前と権限範囲を設定します。
  4. 生成されたトークンをコピーします（一度のみ表示されるため、安全に保管してください）。
PAT は pt- プレフィックスで始まり、pt-your-token-here のような形式です。コードリポジトリに登録したり、公に共有したりしないでください。

​
Bearer ヘッダー形式

リクエストの Authorization ヘッダーに、Bearer 形式で PAT を渡します。 
Authorization: Bearer pt-your-token-here
完全なリクエスト例: 
# Agent 一覧の取得 \
curl -s https://openapi.qoder.sh/api/v1/cloud/agents \
  -H "Authorization: Bearer $QODER_PAT"

​
環境変数の設定（推奨）

ハードコーディングを避けるため、PAT を環境変数として保存することを推奨します。 
# ~/.bashrc または ~/.zshrc に追加 \
export QODER_PAT="pt-your-token-here"

# 設定が反映されているか確認 \
curl -s https://openapi.qoder.sh/api/v1/cloud/agents?limit=1 \
  -H "Authorization: Bearer $QODER_PAT"

​
x-api-key との違い

方式ヘッダー形式適用シーン
Bearer TokenAuthorization: Bearer <PAT>推奨方式、すべての Cloud Agents API 呼び出しに使用
x-api-keyx-api-key: <key>旧バージョンまたはサードパーティ統合のシナリオ。Cloud Agents API は 非対応
Cloud Agents API は Authorization: Bearer 方式のみを受け付けます。x-api-key ヘッダーを使用すると 401 authentication_error が返されます。

​
認証失敗のトラブルシューティング

​
よくあるエラー

HTTP ステータスコードエラータイプ考えられる原因
401authentication_errorPAT が無効、期限切れ、または形式エラー
403permission_errorPAT は有効だが、対象リソースへのアクセス権限がない

​
401 エラーレスポンス例

{
  "type": "error",
  "error": {
    "type": "authentication_error",
    "message": "Invalid API key or token."
  }
}

​
トラブルシューティング手順

  1. PAT が期限切れまたは取り消されていないか確認します。
  2. x-api-key ヘッダーを誤って使用していないか確認します。
  3. Bearer プレフィックスのスペル（大文字小文字、スペース）を確認します。
  4. 環境変数が正しくエクスポートされているか確認します。
# クイック診断: 現在の PAT の先頭数文字を表示してロード状態を確認 \
echo "${QODER_PAT:0:8}..."

​
セキュリティ推奨事項

  • 環境（開発 / テスト / 本番）ごとに独立した PAT を作成してください。
  • トークンを定期的にローテーションしてください。
  • 最小権限の原則に従ってトークンの範囲を割り当ててください。
  • 漏洩を発見した場合は、コンソールで直ちに取り消してください。