API 参考
RelayX API ドキュメントとクイックスタート
クイックスタート
RelayX は AI API を呼び出すための統一された入口を提供します。アカウント、残高、API Key、利用モデルを確認すれば、アプリケーションやスクリプトからすぐに呼び出せます。
利用開始フロー
ログイン
RelayX コンソールにログインし、残高、利用可能なモデル、API Key を確認します。
残高確認
本番利用前に、アカウントに十分な利用可能残高があることを確認してください。
API Key 作成
API Key またはトークン画面でキーを作成し、安全に保存します。公開コードやフロントエンドには含めないでください。
モデル選択
用途に合わせて、テキスト、画像、音声、埋め込みなどのモデルを選択します。モデルごとに料金や速度が異なります。
基本リクエスト
RelayX は一般的な OpenAI 形式の API と互換性があります。ベース URL を RelayX のエンドポイントに変更し、認証ヘッダーに API Key を指定します。
curl https://your-domain/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer sk-your-api-key" \
-d '{
"model": "gpt-4o-mini",
"messages": [
{
"role": "user",
"content": "RelayX を一文で紹介してください。"
}
]
}'利用のポイント
小さくテスト
本番投入前に、少量のリクエストでモデル挙動、レスポンス形式、課金、エラー処理を確認します。
用途に合うモデル
会話、コード、長文、画像、音声、埋め込みでは適したモデルが異なります。まずはバランスの良いモデルから試してください。
キーを保護
API Key はサーバー側の環境変数などに保存し、公開ページやリポジトリに含めないでください。
API 概要
RelayX は AI モデル呼び出し向けの RESTful API を提供し、一般的な OpenAI 形式の連携に対応しています。モデル一覧、チャット、補完、埋め込み、画像生成、音声処理などの機能を利用できます。