はじめに

認証

すべてのリクエストで、いずれかのヘッダーに APIキーを入れて送信します。キーはダッシュボードで発行され、一度だけ表示されます。

この API は有料アカウント(有効なサブスクリプション、または少なくとも1回のクレジットパック購入を完了したアカウント)で利用できます。無料アカウントでもダッシュボードを閲覧できますが、支払い情報が登録されるまで /v1 の呼び出しは 403 を返します。

キーを送る

認証ヘッダー
-H "Authorization: Bearer pb_live_xxx"
# or
-H "x-api-key: pb_live_xxx"
headers = {"Authorization": f"Bearer {API_KEY}"}
const headers = { Authorization: `Bearer ${apiKey}` };

キーのローテーション

  1. まず新しいキーを作成します。稼働中の連携を止めないようにしてください。
  2. 新しいキーを使うようにサービスを更新します。
  3. ダッシュボードで古いキーを無効化します。
キーはサーバー側に保管する 流出した pb_live_ キーは残高をすべて使い切ってしまう可能性があります。シークレットマネージャーに保管し、ブラウザへ送信したりコミットしたりしないでください。

API を使えるアカウント

実際の決済履歴が登録されているアカウントであれば、誰でも利用できます。有効なサブスクリプションまたは少なくとも1回完了したクレジットパック購入があれば十分です。完了した購入は永続的に利用資格を付与するため、現在サブスクリプションが有効でなくてもかまいません。支払い情報が登録されていないアカウントから呼び出すと、error.code 6014 とともに 403 を返します。

ライブラリ & ツール

SDK は不要です。/v1{ success, data } エンベロープを返すシンプルな REST です。型付きクライアントやエージェント連携が必要な場合は、以下をどうぞ。

ライブ仕様から型付きクライアントを生成
# Any OpenAPI 3 generator works — e.g. openapi-generator
npx @openapitools/openapi-generator-cli generate \
  -i https://api.picoberry.ai/api-json \
  -g typescript-fetch -o ./picoberry-client