ドキュメントメニュー

Supernova API#

https://api.supernova.ai を使って、データのクエリ、カタログの確認、ソースの管理、実行の追跡、送信の開始、ログと使用量の読み取り、個人アクセストークンの管理を行います。

bash
curl https://api.supernova.ai/whoami \
  -H "Authorization: Bearer pat_..."

契約#

API パスにバージョンを示す区間はありません。レスポンスには、状態の観測用の Supernova-Version と、サポート用の Request-Id が含まれます。レスポンスのフィールドが追加される場合があるため、クライアントは認識しないフィールドを無視してください。

リソースオブジェクトには、種類を示す object とプレフィックス付きの ID があります。コレクションは {"object":"list","data":[...]} を使用し、ページ分割されるリソースでは、カーソル付きの has_more を提供します。

リソース#

リソース用途
クエリSQL を送信し、Parquet またはインラインの結果を取得
ジョブ実行の一覧表示、確認、追跡、キャンセル、結果の取得
カタログスキーマを一覧表示し、テーブルの列を確認
ソースソースの一覧表示、作成、変更、テスト、削除
同期ソースの同期を開始し、進捗を追跡
送信設定済みの送信を確認、制御
ログソースのエラーとスキーマの変更を読み取り
使用量月ごとの従量使用量と予測費用を読み取り
PAT個人アクセストークンの作成、一覧表示、失効

レート制限#

各呼び出し元は、1 分間に 120 件のリクエストを送信できます。各組織は、呼び出し元全体で 1 分間に 600 件まで送信できます。429 rate_limited レスポンスには、秒単位の Retry-After が含まれます。ポーリングとストリームへの再接続も、リクエストとしてカウントされます。

冪等性#

冪等性への対応を明示した変更用エンドポイントは、Idempotency-Key を受け付けます。同じプリンシパルと組織で再送すると、元のリソースが返されます。同じキーを異なる入力で再利用すると、意図した操作を推測せず、409 を返します。