ドキュメント
Playground から本番環境まで、必要な情報をすべてまとめています。
クイックスタート
アカウントを作成し、ダッシュボードで API キーを作成して、最初のリクエストを送信しましょう。キーは一度しか表示されません。ブラウザのコードではなく、サーバー側のシークレットに保存してください。
curl https://jevai.website/api/v1/systemone \
-H "Authorization: Bearer $JEV_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"state": "The deployment failed three times and production is returning 500s.",
"questions": {
"needs_human": {
"type": "noul",
"instructions": "Should this be escalated to a person?"
}
}
}'リクエスト
`state` と、名前付きの `questions` のマップを含む JSON ボディを送信します。任意の `model` フィールドは互換性のために受け付けますが、無視されます。 `state` には文字列、文字列の配列、または JSON オブジェクトを指定できます(最大 100,000 文字)。
レスポンス
回答は質問名をキーとして返されます。すべてのレスポンスには `request_id` が含まれ、サポートへの問い合わせ時に利用できます。
質問タイプ
各質問には `type` と `instructions` があり、選択とスコアの場合は `criteria` のセットも指定します。 はい / いいえ。回答が「はい」である確率を `noul` として返します。`true` と `false` の説明を含む `criteria` は任意です。 ラベル付きの 2〜20 個の選択肢から 1 つを選びます。`choice`、選択肢ごとの `probabilities`、`confidence` を返します。 状態を 2〜10 段階の順序付きスケール上に配置します。連続値の `score`(0 = 最初のレベル)、`probabilities`、`legend`、`confidence` を返します。
エラー
エラーは常に同じ形式です。メッセージ本文ではなく `error.code` で分岐してください。 `429`、`502`、`529` は指数バックオフでリトライしてください。`401`、`402`、`422` はリクエストを変更せずにリトライしないでください。
| HTTP | コード | 意味 |
|---|---|---|
| 401 | missing_api_key / invalid_api_key | API キーがない、無効、または失効している |
| 402 | insufficient_credits | ワークスペースのクレジットが不足している |
| 422 | invalid_request | JSON の形式が不正、または質問が無効 |
| 429 | rate_limited | レート制限または同時実行数の上限に達した |
| 502 | upstream_error | モデルプロバイダーでエラーまたはタイムアウトが発生した |
| 529 | upstream_overloaded | モデルプロバイダーが過負荷状態 |
クレジットと制限
1 クレジットは入力 1,000 トークンです。実際のトークン数を切り上げ、最低 1 クレジットです。呼び出し前に確保し、失敗すれば返還します。 同時実行数と 1 分あたりのリクエスト数はワークスペースのプランによって異なります。上限を超えると、`Retry-After` ヘッダー付きで `429` が返されます。
データの取り扱い
リクエストは回答を生成するためにモデルへ転送され、内容は保存しません。利用履歴のためにメタデータ(日時、ステータス、クレジット、トークン数)のみを保存します。