Docs

API Dokumentation

Vollständige Referenz für alle Brainiall APIs.

Authentikierung

Alle Endpunkte akzeptieren eine dieser Header (eine verwenden):

Autorisierung: Bearer YOUR_KEYOcp-Apim-Abonnement-Schlüssel: YOUR_KEYApi-Schlüssel: YOUR_KEY

Basis URLhttps://api.brainiall.com

Authentifizierungsdetails

Erhalten Sie einen kostenlosen API-Schlüssel app.brainiall.com (100 Bildkredite / 10 Minuten Audio / 10k Speicherveranstaltungen pro Monat). Der Schlüssel ist ein einziges Bearer-Token, das über alle 48 Endpunkte geteilt wird - keine Pro-Produkt-Kreditials.

Rate Grenzen

Planung	Anrufe / Minute	Konkurrenten	Monatliche Quote
Freie	10	2	100 Bilder / 10 min Audio / 10k Veranstaltungen
Auszahlung - You-Go	120	10	Unbegrenzt (Nutzungsgebühr)
Unternehmer	Personalisierung	Personalisierung	Custom (aufgeforderte Verwendung)

Hinzufügen der pro Minute Limit bringt HTTP zurück 429 Mit den Header Die X-RateLimit-Limit, X-RateLimit-Bewegung, Die X-RateLimit-Resetund Rückkehr nach.

Fehlercode

HTTP	Ursache	Fix
`401`	Vermisst / verschwundenes Bearer-Token	Überprüfen `Autorisierung: Bearer brnl- ...` Der Header ist vorhanden und nicht zurückgegeben.
`403`	Token fehlt für diesen Endpunkt oder die Quote überschritten	Überprüfen /usage für Quota; für Umfang, Kontakt support.
`422`	Validation versagt (z. B. tier="ultra" nicht in enum)	Inspektion `error.details` JSON; Cross-Check mit Öffnen.
`429`	Zinsgrenze überschritten	Ehren `Rückkehr nach` header; back off + retry. Upgrade plan wenn häufig.
`500-599`	Transitionelle Backend-Fehler	Idempotent Retry mit exponentieller Backoff. /status für Unfälle.

Alle Fehlerantworten folgen dem OpenAPI Fehler Die Verpackung : {"error":{"code":N,"message":"...","details":{}}}.

Token Rotation

Verwaltung von Tokens bei /api-tokens - erstellen Sie kurzlebige OAuth-Stil-Token (24h bis 90d Ablauf), nennen Sie sie pro Projekt und widerrufen Sie eine, ohne die anderen zu beeinträchtigen. Langlebige Schlüssel werden automatisch alle 90 Tage drehen; Sie erhalten eine E-Mail an den 14-tägigen und 7-tägigen Marken.

Für Maschinen-Machine-Workflüsse, die nicht rotieren können, verwenden Sie einen Service-Account-Token von /team (Vor den Unternehmensplan)

NLP Suite Endpunkte

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 und Tooling

Verwenden Sie jeden Client-Format – alle bleiben in Synchronisierung mit der Live OpenAPI Spec.

Probieren Sie den interaktiven Explorer Eröffnung 3.1 JSON Eröffnung 3.1 YAML Postman v2.1 Sammlung Postman Umwelt Tippschrift SDK (.tar.gz)Python SDK (.tar.gz )Datenblatt PDF (Sample)

Erstellen eines typischen Kunden: npx @openapitools/openapi-generator-cli generate -i https://app.brainiall.com/openapi.json -g typescript-fetch -o ./brainiall-sdk

Webhooks

Brainiall sendet zwei Arten von Webhooks: Marktplatz SaaS Erfüllung v2 Veranstaltungen (Subscription Lifecycle von Microsoft Azure Marketplace) und Gebrauchsveranstaltungen (Ein Call-Metering drückt auf Ihr Endpunkt, optionale, Pay-as-you-go und Enterprise Pläne).

Marktplatz SaaS Erfüllung v2

Microsoft Azure Marketplace senden Abonnements-Lebenszyklus-Eventen an unsere Webhook-Händler an https://app.brainiall.com/api/marketplace/webhookSie implementieren dies nicht – es ist hier dokumentiert, so dass Unternehmen-Sicherheitsteams die Integration während des Auftrags überprüfen können.

Aktionstypen : Abonnieren, Unabonnieren, AbschließungSubscription, ReinstateSubscription, Wechselplan, VeränderungQuantität, Erneuerung, Übertragung.

Payload Form (Die Schlüsselfelder sind )

{
  "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 ... }
}

Signatur Validierung

Jeder Webhook liefert einen unterzeichneten Bearer-Token in der Autorisierung Header. wir validieren:

Der Algorithmus = Die RS256
Nachfolger = https://sts.windows.net/{tenantId}/
Publikum = unsere AAD-Anwendung ID
JWKS gefangen und verschwunden von https://login.microsoftonline.com/common/discovery/keys
exp Beschwerde innerhalb von 10 Minuten Uhr

Replay-Attack Verteidigung

Jeder activityId wird meist einmal verarbeitet. Wiederholungen des gleichen activityId mit unterschiedlichen action Sie werden mit 409 Konflikte. die timeStamp Das Feld muss innerhalb von 5 Minuten von Server Uhr sein; ältere Anfragen werden mit 401.

Benutzungsveranstaltungen (opt-in)

Auf Pay-as-you-go und Enterprise-Planen können Sie sich für jeden erfolgreichen API-Anruf ein Benutzungsgespräch erhalten, das an Ihre URL übertragen wird. /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..."
}

Unterschrieben mit HMAC-SHA256 über dem Rohkörper mit einem per-tenant-geheimnis, das Sie konfigurieren, wenn Sie sich entscheiden. Die X-Brainiall-SignaturÜberprüfen Sie vor der Verarbeitung.