Download agy2api/docs/README_JA.md from a3216/ds2api: direct link, hf CLI and curl.
- Browser
- Download file 27.7 kB
-
https://huggingface.co/spaces/a3216/ds2api/resolve/main/agy2api/docs/README_JA.md
- Command line
-
hf download hf://spaces/a3216/ds2api/agy2api/docs/README_JA.md
-
curl -L -o README_JA.md https://huggingface.co/spaces/a3216/ds2api/resolve/main/agy2api/docs/README_JA.md
AGY2API
Google AntigravityをOpenAI、Gemini、Claude API互換インターフェースに変換
インストールガイド
Termux環境
初期インストール
curl -o termux-install.sh "https://raw.githubusercontent.com/su-kaka/agy2api/refs/heads/master/termux-install.sh" && chmod +x termux-install.sh && ./termux-install.sh
サービス再起動
cd agy2api
bash termux-start.sh
Windows環境
初期インストール
iex (iwr "https://raw.githubusercontent.com/su-kaka/agy2api/refs/heads/master/install.ps1" -UseBasicParsing).Content
サービス再起動
start.bat をダブルクリックして実行
Linux環境
初期インストール
curl -o install.sh "https://raw.githubusercontent.com/su-kaka/agy2api/refs/heads/master/install.sh" && chmod +x install.sh && ./install.sh
サービス再起動
cd agy2api
bash start.sh
macOS環境
初期インストール
curl -o darwin-install.sh "https://raw.githubusercontent.com/su-kaka/agy2api/refs/heads/master/darwin-install.sh" && chmod +x darwin-install.sh && ./darwin-install.sh
サービス再起動
cd agy2api
bash start.sh
Docker環境
Docker Runコマンド
docker run -d --name agy2api --network host -e API_PASSWORD=api_pwd -e PANEL_PASSWORD=panel_pwd -e PORT=7861 -v $(pwd)/data/creds:/app/creds -v $(pwd)/data/request_logs:/app/data/request_logs ghcr.io/su-kaka/agy2api:latest
Docker Mac
docker run -d \
--name agy2api \
-p 7861:7861 \
-p 8080:8080 \
-e API_PASSWORD=api_pwd \
-e PANEL_PASSWORD=panel_pwd \
-e PORT=7861 \
-v $(pwd)/data/creds:/app/creds \
-v $(pwd)/data/request_logs:/app/data/request_logs \
ghcr.io/su-kaka/agy2api:latest
Docker Compose Runコマンド
- 以下の内容を
docker-compose.ymlファイルとして保存:version: '3.8' services: agy2api: image: ghcr.io/su-kaka/agy2api:latest container_name: agy2api restart: unless-stopped network_mode: host environment: # パスワード設定(個別パスワード) - API_PASSWORD=your_api_password - PANEL_PASSWORD=your_panel_password - PORT=7861 volumes: - ./data/creds:/app/creds - ./data/request_logs:/app/data/request_logs healthcheck: test: ["CMD-SHELL", "python -c \"import sys, urllib.request, os; port = os.environ.get('PORT', '7861'); req = urllib.request.Request(f'http://localhost:{port}/v1/models', headers={'Authorization': 'Bearer ' + os.environ.get('API_PASSWORD', 'pwd')}); sys.exit(0 if urllib.request.urlopen(req, timeout=5).getcode() == 200 else 1)\""] interval: 30s timeout: 10s retries: 3 start_period: 40s - サービスを起動:
docker-compose up -d
コア機能
🔄 APIエンドポイントとフォーマット対応
マルチエンドポイント・マルチフォーマット対応
- OpenAI互換エンドポイント:
/v1/chat/completionsおよび/v1/models- 標準OpenAIフォーマット(messages構造)に対応
- Geminiネイティブフォーマット(contents構造)に対応
- フォーマットの自動検出・変換、手動切替不要
- マルチモーダル入力に対応(テキスト+画像)
- Geminiネイティブエンドポイント:
/v1/models/{model}:generateContentおよびstreamGenerateContent- Geminiネイティブ API仕様に完全対応
- 複数の認証方式: Bearer Token、x-goog-api-keyヘッダー、URLパラメータkey
- Claudeフォーマット互換: Claude APIフォーマットに完全対応
- エンドポイント:
/v1/messages(Claude API仕様に準拠) - Claude標準messagesフォーマットに対応
- systemパラメータおよびClaude固有機能に対応
- バックエンド対応フォーマットへの自動変換
- エンドポイント:
- Antigravity API対応: OpenAI、Gemini、Claudeフォーマットに対応
- OpenAIフォーマットエンドポイント:
/v1/chat/completions - Geminiフォーマットエンドポイント:
/v1/models/{model}:generateContentおよびstreamGenerateContent - Claudeフォーマットエンドポイント:
/v1/messages - 全Antigravityモデルに対応(Claude、Geminiなど)
- モデル名の自動マッピングおよびThinkingモード検出
- OpenAIフォーマットエンドポイント:
🔐 認証とセキュリティ管理
柔軟なパスワード管理
- 個別パスワード対応: APIパスワード(チャットエンドポイント)とコントロールパネルパスワードを個別に設定可能
- 複数の認証方式: Authorization Bearer、x-goog-api-keyヘッダー、URLパラメータなどに対応
- JWTトークン認証: コントロールパネルはJWTトークン認証に対応
- ユーザーメール取得: Googleアカウントのメールアドレスを自動取得・表示
📊 インテリジェントなクレデンシャル管理システム
高度なクレデンシャル管理
- 複数のGoogle OAuthクレデンシャルの自動ローテーション
- 冗長認証による安定性の向上
- ロードバランシングと同時リクエスト対応
- 自動障害検出とクレデンシャル無効化
- クレデンシャル使用統計とクォータ管理
- クレデンシャルファイルの手動有効化/無効化に対応
- クレデンシャルファイルの一括操作(有効化、無効化、削除)
クレデンシャルステータス監視
- リアルタイムのクレデンシャルヘルスチェック
- エラーコードの追跡(429、403、500など)
- 自動BAN機能(設定可能)
🌊 ストリーミングとレスポンス処理
複数のストリーミング対応
- リアルタイムストリーミングレスポンス
- ストリーミング途切れ防止機能(回答の途切れを防止)
- 非同期タスク管理とタイムアウト処理
レスポンス最適化
- 思考チェーン内容の分離
- 推論プロセス(reasoning_content)の処理
- マルチターン会話のコンテキスト管理
🎛️ Web管理コンソール
フル機能のWebインターフェース
- Antigravity OAuth認証フロー(コールバックURLショートカット対応)
- クレデンシャルファイルのアップロード、ダウンロード、管理
- システム設定管理
- 使用統計と監視ダッシュボード
- モバイル対応インターフェース
一括操作対応
- ZIP/JSON一括クレデンシャルアップロード(Antigravity)
- クレデンシャルの一括有効化/無効化/削除
- ユーザーメールの一括取得
- 設定の一括管理
- 全クレデンシャルタイプ統合一括アップロードインターフェース
🔧 高度な設定とカスタマイズ
ネットワークとプロキシ設定
- HTTP/HTTPSプロキシ対応
- プロキシエンドポイント設定(OAuth、Google APIs、メタデータサービス)
- タイムアウトとリトライ設定
- ネットワークエラー処理とリカバリ
パフォーマンスと安定性の設定
- 429エラーの自動リトライ(間隔と回数を設定可能)
- 途切れ防止の最大リトライ回数
ログとデバッグ
- マルチレベルログシステム(DEBUG、INFO、WARNING、ERROR)
- コンソールのみのログ出力(
ENABLE_LOG=0で完全サイレント)
🔄 環境変数と設定管理
柔軟な設定方法
- 環境変数による設定
- ホット設定更新(一部設定項目)
- 設定ロック(環境変数優先)
対応モデル
全モデルが100万トークンのコンテキストウィンドウに対応。各クレデンシャルファイルで1000リクエストのクォータを提供。
🤖 基本モデル
gemini-2.5-progemini-3-pro-previewgemini-3.1-pro-preview
🧠 Thinkingモデル
gemini-2.5-pro-high: Thinkingモードgemini-2.5-pro-low: 低Thinkingモード- カスタムThinkingバジェット設定に対応
- 思考内容と最終回答の自動分離
🔍 検索拡張モデル
gemini-2.5-pro-search: 検索機能統合モデル
🖼️ 画像生成モデル(Antigravity)
gemini-3.1-flash-image: 基本画像生成モデル- 解像度サフィックス:
-2k: 2K解像度-4k: 4K HD解像度
- アスペクト比サフィックス:
-1x1: 正方形(アバター)-16x9: 横長(デスクトップ壁紙)-9x16: 縦長(モバイル壁紙)-21x9: ウルトラワイド(ウルトラワイドモニター)-4x3: 従来のディスプレイ-3x4: 縦型ポスター
- 組み合わせ例:
gemini-3.1-flash-image-4k-16x9: 4K横長gemini-3.1-flash-image-2k-9x16: 2K縦長
- 比率未指定時はAPIが自動的にアスペクト比を決定
🌊 特殊機能バリアント
- 途切れ防止モード: モデル名に
抗截断-プレフィックスを追加- 例:
抗截断-gemini-2.5-pro - 合成ツール呼び出しで途切れ制限を回避し、完全な回答を保証(ストリーミング・非ストリーミング両対応)
- 例:
🔧 モデル機能の自動検出
- システムがモデル名内の機能識別子を自動認識
- 機能モード切替を透過的に処理
- 機能の組み合わせ使用に対応
設定手順
http://127.0.0.1:7861にアクセス(デフォルトポート、PORT環境変数で変更可能)- OAuth認証フローを完了(デフォルトパスワード:
pwd、環境変数で変更可能)- GCLIモード: Google Cloud Gemini APIクレデンシャルの取得用
- クライアントを設定:
OpenAI互換クライアント:
- エンドポイントアドレス:
http://127.0.0.1:7861/v1 - APIキー:
pwd(デフォルト値、API_PASSWORD環境変数で変更可能)
Geminiネイティブクライアント:
- エンドポイントアドレス:
http://127.0.0.1:7861 - 認証方式:
Authorization: Bearer your_api_passwordx-goog-api-key: your_api_password- URLパラメータ:
?key=your_api_password
💾 データストレージモード
🌟 ストレージバックエンド対応
agy2apiは2つのストレージバックエンドに対応: ローカルSQLite(デフォルト) と PostgreSQL(クラウド分散ストレージ)
📁 ローカルSQLiteストレージ(デフォルト)
デフォルトストレージ方式
- 設定不要、すぐに利用可能
- データはローカルSQLiteデータベース(
creds/credentials.db)に保存 - 単一マシンデプロイおよび個人利用に最適
クレデンシャル構造
クレデンシャルはメールアドレス(email)を一意キーとして構造化データベースカラムで保存されます(JSON blobは不使用):
email、access_token、refresh_token、client_id、client_secret、project_id、expiry、tier
インポート/エクスポートは標準化JSON形式: {"refresh_token": "...", "access_token": "...", "expiry": "...", "email": "...", "tier": "...", "project_id": "..."}(refresh_token のみ必須、有効期限内の access_token はそのまま再利用、残りは自動取得)。
環境変数設定
基本設定
PORT: サービスポート(デフォルト: 7861)HOST: サーバーリッスンアドレス(デフォルト: 0.0.0.0)
パスワード設定
API_PASSWORD: チャットAPIアクセスパスワード(デフォルト: pwd)PANEL_PASSWORD: コントロールパネルアクセスパスワード(デフォルト: pwd)
アクセス制御設定
IP_WHITELIST_ENABLED: IPホワイトリストの有効化(デフォルト: false、制限なし)IP_WHITELIST: IPホワイトリスト、カンマまたは改行区切り(デフォルト: 空)。各エントリは単一IP(192.168.1.1)、CIDR範囲(192.168.1.0/24)、開始-終了範囲(10.0.0.1-10.0.0.100)に対応、IPv4 / IPv6 両方可。有効化するとホワイトリスト内のIPのみがパネルとAPIにアクセスでき、それ以外は 403。パネル保存後すぐに有効
モデル名リライト設定
MODEL_REWRITE_ENABLED: モデル名リライトの有効化(デフォルト: false)MODEL_REWRITE_RULES: リライトルール、各[マッチ正規表現, 置換モデル名](デフォルト: 空)。上から最初にマッチしたものが有効、置換は正規表現の後方参照(例:\1)に対応。例:gpt-4oをgemini-2.5-proにマッピング。パネル保存後すぐに有効
パフォーマンスと安定性の設定
RETRY_429_ENABLED: 429エラー自動リトライの有効化(デフォルト: true)RETRY_429_MAX_RETRIES: 429エラーの最大リトライ回数(デフォルト: 5)RETRY_429_INTERVAL: 429エラーのリトライ間隔、秒単位(デフォルト: 1.0)ANTI_TRUNCATION_MAX_ATTEMPTS: 途切れ防止の最大リトライ回数(デフォルト: 3)
ネットワークとプロキシ設定
PROXY: プロキシアドレス(http://、https://、socks5://、socks5h://対応、user:pass@host:port形式の認証情報付きも可)OAUTH_PROXY_URL: OAuth認証プロキシエンドポイントGOOGLEAPIS_PROXY_URL: Google APIsプロキシエンドポイントPATH_PREFIX: リバースプロキシがパスプレフィックスを保持する場合(例:/AGY2API)、バックエンドがルーティング前にプレフィックスを剥がすよう設定。デフォルト: 空(剥がさない)
自動化設定
AUTO_BAN: クレデンシャル自動BANの有効化(デフォルト: false)AUTO_BAN_ERROR_CODES: 自動BANをトリガーするエラーコード(デフォルト: 403)
ログ設定
LOG_LEVEL: ログレベル(DEBUG/INFO/WARNING/ERROR、デフォルト: INFO)ENABLE_LOG: 完全サイレント(0で無効化、デフォルト: 1)
レスポンス動作設定
RETURN_THOUGHTS_TO_FRONTEND: 思考チェーンをフロントエンドに返す(デフォルト: true)
センシティブワードフィルタリング
SENSITIVE_WORDS_ENABLED: センシティブワードフィルタリングの有効化(デフォルト: false)SENSITIVE_WORDS: センシティブワードリスト、カンマまたは改行区切り(デフォルト: 空)。ヒットすると空文字列に置換、大文字小文字を区別しない、中国語対応、パネル保存後すぐに有効
使用ログ
USAGE_LOG_ENABLED: リクエストログの有効化(デフォルト: true)。すべてのAPIリクエスト(モデル、クレデンシャル、トークン使用量、レイテンシ、ステータス)をデータベースに記録。自動削除なし、パネルから手動クリア可能
リクエストボディデバッグログ
REQUEST_LOG_ENABLED: リクエストボディ詳細ログの有効化(デフォルト: false)。有効化すると、最終ステータスコードが指定コードに一致した場合、上流へ送信した完全なリクエストヘッダー(マスク済み)とボディを JSON ファイルとしてdata/request_logs/に保存。データベースにはファイル索引のみ記録し、リクエストログ詳細から閲覧可能。主にリクエストボディエラー(例: 400)のデバッグ用。ログのクリア/全削除時にこれらのファイルも削除(Docker では./data/request_logs:/app/data/request_logsをマウントして永続化)REQUEST_LOG_ERROR_CODES: デバッグログを記録するステータスコードリスト、カンマ区切り(デフォルト: 400)
クレデンシャル選択モード
CREDENTIAL_SELECT_MODE: クレデンシャル選択モード(デフォルト: cache)random— 完全ランダムな負荷分散、各リクエストはランダムにクレデンシャルを選択cache— キャッシュマッチング(推奨):「モデル + システム指示(または最初の user メッセージ)」をハッシュ化したセッションキーで、同じセッションは同じクレデンシャルを再利用し、Google 上流の prompt cache にヒット。クールダウン後は自動切替と再バインドsticky— スティッキー: すべてのリクエストが CD に入るか無効化されるまで同じクレデンシャルに固定
REDIS_URL: Redis 接続文字列(オプション)。設定するとキャッシュモードのセッションバインドを Redis に保存しマルチインスタンス共有。未設定時はプロセス内メモリバックエンドを使用
ストレージ設定
SQLite(デフォルト)
- 設定不要、
creds/にデータベースファイルを自動作成
PostgreSQL(オプションのクラウドストレージ)
POSTGRESQL_URI: PostgreSQL接続文字列(設定するとPostgreSQLモードが有効)
Docker使用例
docker run -d --name agy2api \
-e API_PASSWORD=my_api_password \
-e PANEL_PASSWORD=my_panel_password \
-e PORT=7861 \
ghcr.io/su-kaka/agy2api:latest
API使用方法
本サービスは複数の完全なAPIエンドポイントセットに対応しています:
3. Claude APIフォーマットエンドポイント
エンドポイント: /v1/messages
認証: x-api-key: your_api_password または Authorization: Bearer your_api_password
リクエスト例:
curl -X POST "http://127.0.0.1:7861/v1/messages" \
-H "x-api-key: your_api_password" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "gemini-2.5-pro",
"max_tokens": 1024,
"messages": [
{"role": "user", "content": "Hello, Claude!"}
]
}'
systemパラメータの対応:
{
"model": "gemini-2.5-pro",
"max_tokens": 1024,
"system": "You are a helpful assistant",
"messages": [
{"role": "user", "content": "Hello"}
]
}
注意事項:
- Claude APIフォーマット仕様に完全互換
- バックエンド呼び出し時にGeminiフォーマットへ自動変換
- すべてのClaude標準パラメータに対応
- レスポンスフォーマットはClaude API仕様に準拠
Antigravity APIエンドポイント
OpenAI、Gemini、Claudeの3フォーマットに対応
Antigravity OpenAIフォーマットエンドポイント
エンドポイント: /v1/chat/completions
認証: Authorization: Bearer your_api_password
リクエスト例:
curl -X POST "http://127.0.0.1:7861/v1/chat/completions" \
-H "Authorization: Bearer your_api_password" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"messages": [
{"role": "user", "content": "Hello"}
],
"stream": true
}'
Antigravity Geminiフォーマットエンドポイント
非ストリーミングエンドポイント: /v1/models/{model}:generateContent
ストリーミングエンドポイント: /v1/models/{model}:streamGenerateContent
認証方式(いずれか1つを選択):
Authorization: Bearer your_api_passwordx-goog-api-key: your_api_password- URLパラメータ:
?key=your_api_password
リクエスト例:
# Geminiフォーマット非ストリーミングリクエスト
curl -X POST "http://127.0.0.1:7861/v1/models/claude-sonnet-4-5:generateContent" \
-H "x-goog-api-key: your_api_password" \
-H "Content-Type: application/json" \
-d '{
"contents": [
{"role": "user", "parts": [{"text": "Hello"}]}
],
"generationConfig": {
"temperature": 0.7
}
}'
# Geminiフォーマットストリーミングリクエスト
curl -X POST "http://127.0.0.1:7861/v1/models/gemini-2.5-flash:streamGenerateContent?key=your_api_password" \
-H "Content-Type: application/json" \
-d '{
"contents": [
{"role": "user", "parts": [{"text": "Hello"}]}
]
}'
Antigravity Claudeフォーマットエンドポイント
エンドポイント: /v1/messages
認証: x-api-key: your_api_password
リクエスト例:
curl -X POST "http://127.0.0.1:7861/v1/messages" \
-H "x-api-key: your_api_password" \
-H "anthropic-version: 2023-06-01" \
-H "Content-Type: application/json" \
-d '{
"model": "claude-sonnet-4-5",
"max_tokens": 1024,
"messages": [
{"role": "user", "content": "Hello"}
]
}'
対応Antigravityモデル:
- Claudeシリーズ:
claude-sonnet-4-5、claude-opus-4-5など - Geminiシリーズ:
gemini-2.5-flash、gemini-2.5-proなど - Thinkingモデルに自動対応
Geminiネイティブの例:
from io import BytesIO
from PIL import Image
from google.genai import Client
from google.genai.types import HttpOptions
from google.genai import types
# クライアントは環境変数 `GEMINI_API_KEY` からAPIキーを取得します。
client = Client(
api_key="pwd",
http_options=HttpOptions(base_url="http://127.0.0.1:7861"),
)
prompt = (
"""
猫を描いて
"""
)
response = client.models.generate_content(
model="gemini-3.1-flash-image",
contents=[prompt],
config=types.GenerateContentConfig(
image_config=types.ImageConfig(
aspect_ratio="16:9",
)
)
)
for part in response.candidates[0].content.parts:
if part.text is not None:
print(part.text)
elif part.inline_data is not None:
image = Image.open(BytesIO(part.inline_data.data))
image.save("generated_image.png")
注意事項:
- OpenAIエンドポイントはOpenAI互換フォーマットを返します
- GeminiエンドポイントはGeminiネイティブフォーマットを返します
- 両エンドポイントとも同一のAPIパスワードを使用
📋 完全なAPIリファレンス
Webコンソール API
認証エンドポイント
POST /auth/login- ユーザーログインPOST /auth/start- Antigravity OAuth認証の開始POST /auth/callback- OAuthコールバックの処理POST /auth/callback-url- コールバックURLから直接認証を完了GET /auth/status/{project_id}- 認証ステータスの確認
クレデンシャル管理エンドポイント
POST /creds/upload- クレデンシャルファイルの一括アップロード(JSONおよびZIP対応)GET /creds/status- クレデンシャルステータス一覧の取得(ページネーションとフィルタリング対応)GET /creds/detail/{email}- 単一クレデンシャルの詳細取得POST /creds/action- 単一クレデンシャル操作(有効化/無効化/削除)POST /creds/batch-action- クレデンシャルの一括操作GET /creds/export/{email}- 単一クレデンシャルを標準化JSONでエクスポートGET /creds/download-all- 全クレデンシャルの一括ダウンロードPOST /creds/refresh-all-emails- ユーザーメールの一括更新POST /creds/deduplicate-by-email- メールによるクレデンシャルの重複排除GET /creds/quota/{email}- クレデンシャルのクォータ情報取得
設定管理エンドポイント
GET /config/get- 現在の設定の取得POST /config/save- 設定の保存
バージョン情報エンドポイント
GET /version/info- バージョン情報の取得(オプションcheck_update=trueパラメータで更新確認)
チャットAPI機能
マルチモーダル対応
{
"model": "gemini-2.5-pro",
"messages": [
{
"role": "user",
"content": [
{"type": "text", "text": "この画像を説明してください"},
{
"type": "image_url",
"image_url": {
"url": "data:image/jpeg;base64,/9j/4AAQSkZJRgABA..."
}
}
]
}
]
}
Thinkingモード対応
{
"model": "gemini-2.5-pro-high",
"messages": [
{"role": "user", "content": "複雑な数学の問題"}
]
}
レスポンスには分離された思考内容が含まれます:
{
"choices": [{
"message": {
"role": "assistant",
"content": "最終回答",
"reasoning_content": "詳細な思考プロセス..."
}
}]
}
途切れ防止の使用方法
{
"model": "抗截断-gemini-2.5-pro",
"messages": [
{"role": "user", "content": "長い記事を書いてください"}
],
"stream": true
}
🛠️ フロントエンド開発
パネルのフロントエンドソースは frontend/ にあります(React + Vite + Tailwind CSS):
cd frontend
npm install
npm run dev # 開発モード、ポート3000、バックエンドAPIをプロキシ
npm run build # dist/ にビルド(本番で使用)
バックエンドは dist/ のコンパイル済み静的ファイルを直接配信します。Node.jsランタイムは不要です。
💬 コミュニティ
QQグループへの参加をお待ちしています!
QQグループ: 1083250744
ライセンスと免責事項
本プロジェクトは学習および研究目的のみに使用できます。本プロジェクトの使用は、以下に同意したことを意味します:
- 本プロジェクトをいかなる商用目的にも使用しないこと
- 本プロジェクトの使用に伴うすべてのリスクと責任を負うこと
- 関連するサービス利用規約および法的規制を遵守すること
プロジェクトの作者は、本プロジェクトの使用から生じるいかなる直接的または間接的な損害についても責任を負いません。
⚠️ ライセンスについて
本プロジェクトはCooperative Non-Commercial License (CNC-1.0) の下でライセンスされています
これは厳格な非商用オープンソースライセンスです。詳細は LICENSE ファイルをご参照ください。
✅ 許可される用途:
- 個人の学習、研究、教育目的
- 非営利団体での利用
- オープンソースプロジェクトへの統合(同一ライセンスの遵守が必要)
- 学術研究および論文発表
❌ 禁止される用途:
- あらゆる形態の商用利用
- 年間売上が100万ドルを超える企業での利用
- ベンチャーキャピタルの出資を受けた企業または上場企業
- 有料サービスまたは製品の提供
- 商業的な競合利用