Ultineo AI の API
カタログのアプリケーションを自社のソフトウェアから実行できます。API は HTTPS 上で JSON を扱い、各呼び出しをプロジェクトキーで認証し、すべての呼び出しに同じ形式で応答します。
3 つのリソースを中心に設計
- カタログ
公開済みのアプリケーションを利用の多い順に、それぞれが必要とする入力フィールドとともに一覧できます。
- 実行
1 回の呼び出しでアプリケーションを入力とともに起動し、別の呼び出しで実行結果と回答を読み取ります。
- キー
スコープ、任意の有効期限、無効化できるステータスを備えたプロジェクトキー。
認証とスコープ
- Bearer キー
すべての呼び出しで、プロジェクトキーを Authorization ヘッダーに入れて送信してください。通信は HTTPS のみです。
- 1 つのプロジェクトに限定
キーは 1 つのプロジェクトに紐づき、どのようなリクエストであっても、別のプロジェクトのデータを読み書きすることはできません。
- ハッシュとして保存
保存されるのはキーのハッシュのみのため、キー全体が表示されるのは 1 回だけです。紛失したキーは再発行され、復元されることはありません。
実行を開始して回答を読み取る
- 作成
アプリケーションを指定し、カタログが返すフィールド名をキーにして、入力フィールドごとに値を 1 つ渡します。
- 追跡
実行は非同期です。ステータスが完了または失敗になるまで読み取りを繰り返してください。どちらも最終状態です。
- 読み取り
完了した実行には、回答、所要時間、入力と出力のトークン数が含まれます。
すべての応答に共通の形式
- 常に同じ 3 つのフィールド
すべての応答には、成功時も失敗時も、ステータスコード、短いタイトル、レスポンスが含まれます。
- 一貫したメッセージ
エラーメッセージは英語の固定文字列で、不足しているスコープや拒否された値を示します。
- 明確なプランの上限
プランの対象外の呼び出しや、利用枠を超える呼び出しは、専用のステータスコードで拒否されます。
キーの取得
API アクセスは Ultineo AI の有料プランに含まれます。セルフサービスでの登録にはまだ対応していません。当社チームがプロジェクトを開設し、最初のキーをお渡しします。
API に関するご質問
有料プランです。無料プランではアプリケーションを利用できますが、API は含まれません。
いいえ。指示はアプリケーションの所有者のものです。API が返すのは入力フィールドで、呼び出し側が入力するのはこの部分です。
実行を作成すると、新しいステータスがすぐに返されます。回答を得るには、実行が完了するまで読み取りを繰り返してください。
はい。各キーにはスコープと任意の有効期限があり、キーが自分より広いスコープを持つ別のキーを作成することはできません。