Skip to main content
ドクター

API ドキュメント

すべての Brainiall APIs の完全な参照。

認証

すべてのエンドポイントは、これらのヘッダーのいずれかを受け入れる(1つを使用する):

ライセンス: Bear Your_Keyサブスクリプションキー: YOUR_KEYタイトル:Your_Key
ベースURLhttps://api.brainiall.com

認証の詳細

無料 API キーを取得する app.brainiall.com (100 画像クレジット / 10 分のオーディオ / 10k メモリイベント / 月) キーは、すべての 48 エンドポイントで共有された単一の Bearer トークンです - 製品当たりの認証はありません。

レート制限

プラン電話 / 分競争月額関税
フリー102100 画像 / 10 分のオーディオ / 10k イベント
☆☆☆☆☆☆☆☆☆☆12010無制限(利用料)
企業カスタマイズカスタマイズカスタム(コマンド使用)

1分間の制限を押すと、HTTPが戻ります。 429 主人公と共に レベル X レベル, Xレートレイアウト, Xレートリミットリセットそして、 後退.

エラーコード

HTTP原因修正
401失われた / 歪んだベアラー トークンチェック ライセンス: Bearer brnl-... ヘッダーは存在し、返却されていません。
403トークンはこの最終点または割合を超える範囲がありません。チェック /usage コントロール・コントロール・コントロール support.
422認証が失敗した(例えば, tier="ultra" not in enum)検査 error.details JSON; クロスチェック オープン.
429利率制限を超える名誉 後退 タイトル; back off + retry. upgrade plan if frequent.
500-599トランスジェンダーバックエラーエクスポンシャル・バックコーフ(エクスポンシャル・バックコーフ) /status 事故について。

すべてのエラー回答は OpenAPI に従います。 エラー 包装: {"error":{"code":N,"message":"...","details":{}}}.

トークン回転

トークンを管理する /api-tokens - 短期 OAuth スタイルのトークンを作成する(24h から 90d 終了)、プロジェクトごとに指定し、他のものに影響を与えずにいずれかをキャンセルします。

回転できないマシン・マシン・ワークフローの場合、サービス・アカウント・トークンを使用してください。 /team (事業計画)

NLP Suite エンドポイント

Detect toxic, offensive, or harmful content in text.

curl -X POST https://api.brainiall.com/v1/nlp/toxicity \
 -H "Authorization: Bearer YOUR_KEY" \
 -H "Content-Type: application/json" \
 -d '{"text":"This product is absolutely amazing"}'

SDK&ツール

クライアントフォーマットを使用する - すべてはライブ OpenAPI スペックと同期されます。

タイプ化されたクライアントを作成する: npx @openapitools/openapi-generator-cli generate -i https://app.brainiall.com/openapi.json -g typescript-fetch -o ./brainiall-sdk

Webハウス

Brainiall は 2 種類の Webhooks を送信します。 マーケティング SaaS 満たす v2 イベント(Microsoft Azure Marketplaceからのサブスクリプションライフサイクル)および 利用イベント (電話による測定は、最終点、選択肢、Pay-as-you-goおよびEnterpriseプランに押し付ける)。

マーケティング SaaS 満たす v2

Microsoft Azure Marketplace は、サブスクリプションライフサイクルイベントを当社の Webhook ディーラーに送信します。 https://app.brainiall.com/api/marketplace/webhookあなたはこれを実施しません - これはここで文書化されているので、企業のセキュリティチームは買収中に統合を監査することができます。

アクションタイプ: サブスクリプション, 未登録, サブスクリプション, リセットサブスクリプション, 変更プラン, 変更量, 再生, 転送.

支払い形式 (キーフィールド)

{
  "id":              "uuid",
  "activityId":      "uuid",
  "subscriptionId":  "uuid",
  "publisherId":     "brainiall-publisher-id",
  "offerId":         "specialist-ai-apis",
  "planId":          "s1-background-removal-fast",
  "quantity":        1,
  "action":          "Subscribe",
  "timeStamp":       "2026-04-29T08:30:00.0000000Z",
  "status":          "InProgress",
  "operationRequestSource": "Azure",
  "subscription": { ...full subscription object ... }
}

署名認証

すべての Webhook が署名された Bearer トークンを提供します。 許可 タイトル:We validate:

  • アルゴリズム= RS256
  • アイドル= https://sts.windows.net/{tenantId}/
  • 観客 = 私たちのAADアプリケーションID
  • ☆☆☆☆☆☆☆☆☆☆☆☆☆☆☆☆☆☆ https://login.microsoftonline.com/common/discovery/keys
  • exp 10分以内の時計スケーブル

再攻撃防衛

activityId 繰り返し繰り返し繰り返し繰り返し繰り返し activityId 異なるものと action 拒否され、 第409話 衝突・The timeStamp フィールドはサーバー時刻から5分以内でなければなりません; 古いリクエストは拒否されます。 401.

利用イベント(opt-in)

Pay-as-you-go および Enterprise プランでは、あなたの URL に送信されたすべての成功した API 通話の使用イベントを受け取ることを選択できます。 /webhooks.

{
  "event":      "api.call",
  "id":         "evt_2K9...",
  "created":    "2026-04-29T08:30:00.123Z",
  "endpoint":   "/v1/image/remove-background/base64",
  "sku":        "s1-background-removal",
  "tier":       "hd",
  "tokens_in":  null,
  "tokens_out": null,
  "units":      1,
  "unit_kind":  "image",
  "duration_ms": 3142,
  "status":     200,
  "request_id": "req_8c3..."
}

HMAC-SHA256 を使用して原体に署名し、入力時に設定する秘密を使用します。 Xブレイニャル署名処理前に確認する。

Brainiall 開発者ポータル