APIリファレンス
アプリケーションを認証し、テキストと画像を生成し、埋め込みを作成し、プロバイダー、デバイス、クリエイターのワークフローを自動化します。
最初のAPIリクエストを作成する
ShareAI APIキーを作成し、利用可能なモデルを選択して、サーバーからBearer認証を使用してチャットリクエストを送信します。
適切なAPIと認証情報を選択する
アプリケーション認証、チャット、応答、埋め込み、画像、プロバイダー、デバイス、クリエイターのためのShareAI APIエンドポイントを、正しいURLと認証情報で見つけてください。
アプリケーションの登録
アプリケーションを作成し、デプロイメントモデルを選択して、必要なShareAI機能のみを有効にしてください。
PKCEを使用したアカウントの認証
機密性の高いアプリケーションおよび公開アプリケーションには、認可コードとS256 PKCEを使用してください。
ログイン、支払い、AIスコープの選択
ログイン、製品の支払い、推論追加料金には、それぞれ別の機能と顧客の認可が必要です。
アクセストークンの更新
顧客が認可したスコープを拡大することなく、リフレッシュトークンをローテーションしてください。
IDを読み取り、認証エンドポイントを発見する
ShareAI Authのディスカバリー、JWKS、UserInfoを使用してアプリケーションのサインインを検証し、OAuthアクセストークンで許可されたアイデンティティを読み取ります。
トークンの取り消しとサーバー側認証の確認
使用されていないアクセスおよびリフレッシュトークンを無効化してください。機密統合ではトークンの状態を確認することも可能です。
承認された請求契約を理解する
サブスクリプション価格、間隔、AI追加料金は、各顧客が承認した条件に基づいて維持してください。
チャット補完を作成する
Bearer APIキーを使用してShareAIチャット補完リクエストを送信し、サポートされているモデル、メッセージ、ストリームフィールドを理解してください。
OAuthを使用してチャットリクエストを送信する
顧客資金提供のチャット完了のために承認された ShareAI OAuth アクセストークンを使用し、トークンの有効期限、同意、およびアカウントの境界を処理します。
チャット応答をストリームする
ShareAIチャット補完のサーバー送信イベントを読み取り、コンテンツデルタを一度だけ追加し、完了、エラー、および中断されたストリームを処理します。
キーアクセスとアカウントIDを検査する
推論クレデンシャルに関連付けられたアカウントのIDやモデルおよびプロバイダーの制限を確認するために、ShareAI APIキー情報を読む。
テキスト応答を作成
ShareAI Responses APIを使用して、ステートレスなテキスト生成、明示的な会話履歴、およびResponsesストリーミングイベントを実現します。
テキスト埋め込みを作成
ShareAIを使用して、セマンティック検索、情報検索、類似性のためのテキスト埋め込みを生成します。サポートされている入力形式とモデル要件を確認してください。
画像を生成
ShareAI Images APIを使用して、サポートされるモデル、テキストプロンプト、および検証済みの画像生成オプションで画像を作成します。
プロバイダーAPIを認証する
プロバイダーリモートアクセスを有効にし、プロバイダーUUIDとスコープされたアクセストークンを使用してカタログおよび価格リクエストを行います。
プロバイダーおよびネットワークモデルを一覧表示する
ShareAI Provider APIネットワークカタログ、プロバイダーカタログ、および正確なモデル詳細をprovider_models:readを使用して読み取ります。
プロバイダーモデルの価格を更新する
スコープされたプロバイダーAPIトークンと正確なモデル識別子を使用して、ShareAIプロバイダーモデルの入力、出力、およびキャッシュの価格設定階層を設定します。
デバイスAPIを認証する
両方のレイヤーを有効にする.
デバイスセッションとタスク履歴を読み取る
ShareAIデバイスセッションをリストし、デバイス固有のリモートコントロールトークンを使用してセッションのタスク履歴を確認します。
デバイス共有を開始および停止する
ShareAIデバイス共有コマンドを送信し、受け入れられたコマンドと観測された状態を区別し、結果をConsoleで確認します。
クリエイターAPIを認証する
Creatorスコープのリモートアクセス資格情報を使用し、ShareAI Creator APIで利用可能なコレクション、モデル、設定スコープを理解してください。
モデルコレクションを読み取り、管理する
必要なスコープと明確な所有権およびレビューの境界を持つShareAI Creatorモデルコレクションをリスト、作成、更新します。
モデルパッケージを作成する
ShareAI Creatorモデルメタデータ、コレクション、モデルタグを明示的なアクセスポリシーとスコープ付きAPI認証情報とともに一括作成します。
コレクション内のモデルを管理する
ShareAI Creator モデルタグをリスト、読み取り、作成、更新し、コレクションの所有権と有効な提供ポリシーを保持します。
APIエラーと再試行を処理する
ShareAI の認証、スコープ、モデルアクセス、可用性エラーを重複書き込みや安全でないリフレッシュ再試行なしで診断します。
モデル作成者、識別子、タグを理解する
作成者ベースの正確なShareAIモデル識別子を選択し、そのファミリーを探索し、それを実行できるプロバイダーを比較してください。
APIリクエストの実行プロバイダーを選択する
ShareAIプロバイダーオブジェクトを使用して、すべての4つの推論エンドポイントにおいてモデルのCreatorとは独立して実行プロバイダーを選択します。
プロバイダーポリシーリファレンス
推論リクエストで実行プロバイダーを選択する際に、ShareAIプロバイダーのフィールド、デフォルト、制限、およびエラーを参照してください。
プロバイダーを並べ替え、フォールバックを制御する
ShareAIの価格、遅延およびスループットランキング、プロバイダーの順序、利用不可の測定値、安全なフォールバック境界について理解する。
顧客の身元を理解する
各OAuthクライアントは、同じShareAIカスタマーに対して異なる識別子を受け取ります。
製品とサブスクリプションの支払い
ウォレットチェックアウトを作成し、ShareAIで顧客に確認させ、支払い結果を検証してから実行する。
請求エラーと顧客の支出制限の処理
アプリケーションの支出制限とクレジット不足を区別し、アクター認識型のリカバリリンクを提示し、ストリーミングエラーを正しく処理します。