Zum Hauptinhalt springen

HĂ€ufig gestellte Fragen

Authentifizierung & Zugang​

Wie erhalte ich API-Anmeldedaten?

Gehen Sie zu Service Accounts in der neuroflash App und erstellen Sie einen neuen Service Account. Sie erhalten eine client_id und ein client_secret. Die vollstÀndige Einrichtungsanleitung finden Sie unter Authentifizierung.

Wie lange sind Access Tokens gĂŒltig?

Access Tokens sind ungefĂ€hr 4 Stunden (14.399 Sekunden) gĂŒltig. Wenn Ihr Token ablĂ€uft, gibt die API eine 401 Unauthorized-Antwort zurĂŒck. Fordern Sie einen neuen Token mit demselben Client-Credentials-Flow an.

Sie sollten Ihren Token cachen und wiederverwenden, bis er ablĂ€uft — es ist nicht notwendig, fĂŒr jeden API-Aufruf einen neuen Token anzufordern.

Kann ich die API aus clientseitigem/Browser-Code verwenden?

Nein. Ihr client_secret muss vertraulich bleiben und darf niemals in clientseitigem Code, mobilen Apps oder Browser-JavaScript offengelegt werden. Rufen Sie die neuroflash API immer von einem Backend-Server aus auf.

Workspaces & Kontingente​

Wie finde ich meine Workspace-ID?

Rufen Sie den Endpoint Workspaces auflisten auf:

GET https://app.neuroflash.com/api/workspace-service/v1/workspaces

Die Antwort enthÀlt alle Workspaces, auf die Ihr Service Account Zugriff hat. Verwenden Sie das id-Feld des Workspaces, mit dem Sie arbeiten möchten. Ein vollstÀndiges Beispiel finden Sie im Schnellstart.

Was ist der Unterschied zwischen tÀglichen und monatlichen Limits?

Ihr Workspace hat sowohl ein monatliches Limit (limitAmount) als auch ein tĂ€gliches Limit (limitAmountDaily). Das tĂ€gliche Limit verhindert ĂŒbermĂ€ĂŸige Nutzung an einem einzelnen Tag, wĂ€hrend das monatliche Limit die Gesamtnutzung fĂŒr den Abrechnungszeitraum begrenzt. FĂŒr eine erfolgreiche Anfrage muss bei beiden noch KapazitĂ€t verfĂŒgbar sein.

ÜberprĂŒfen Sie Ihre aktuelle Nutzung mit dem Kontingente-Endpoint.

Was passiert, wenn mein Kontingent zurĂŒckgesetzt wird?

Monatliche Kontingente werden zu Beginn jedes Abrechnungszeitraums zurĂŒckgesetzt. TĂ€gliche Kontingente (usedAmountDaily) werden jeden Tag zurĂŒckgesetzt. Das Feld dailyRefreshed in der Kontingent-Antwort zeigt das Datum der letzten tĂ€glichen ZurĂŒcksetzung.

Was bedeutet fairUseLimitReached?

Wenn fairUseLimitReached den Wert true hat, hat Ihr Workspace den Schwellenwert der Fair-Use-Richtlinie erreicht. Dies ist unabhĂ€ngig von Ihren regulĂ€ren Kontingentlimits und dient dazu, Missbrauch zu verhindern. Die API gibt eine 403 Forbidden-Antwort zurĂŒck, bis das Limit zurĂŒckgesetzt wird. Wenn Sie glauben, dass dies ein Fehler ist, wenden Sie sich an den Support.

Content-Generierung​

Welche KI-Modelle sind verfĂŒgbar?

Die verfĂŒgbaren Modelle hĂ€ngen vom Abonnementplan Ihres Workspaces ab. Rufen Sie den Modelle-Endpoint auf, um die Modelle aufzulisten, auf die Sie Zugriff haben. Modelle von Anbietern wie OpenAI (GPT), Anthropic (Claude), Google (Gemini) und Mistral können verfĂŒgbar sein.

Wie funktioniert die Wortverbrauchserfassung?

Jede Content-Generierungsanfrage verbraucht Wörter aus dem Kontingent Ihres Workspaces. Die Anzahl der verbrauchten Wörter hĂ€ngt von der LĂ€nge des generierten Inhalts ab. ÜberprĂŒfen Sie Ihr verbleibendes Wortguthaben mit dem Kontingente-Endpoint.

Kann ich Antworten streamen?

Der Chat-Completions-Endpoint unterstĂŒtzt Streaming ĂŒber Server-Sent Events. Setzen Sie "stream": true in Ihrem Request Body, um inkrementelle Antworten zu erhalten, wĂ€hrend diese generiert werden.

Allgemein​

Welches Format haben Request- und Response-Bodies?

Alle Request- und Response-Bodies verwenden JSON. Setzen Sie den Header Content-Type: application/json bei Anfragen, die einen Body enthalten. Antworten liefern immer JSON mit Content-Type: application/json zurĂŒck.

Wie melde ich ein Problem oder erhalte Support?
  • Bei Problemen mit der API-Dokumentation erstellen Sie ein Issue im Dokumentations-Repository
  • Bei API-Fehlern oder Kontoproblemen kontaktieren Sie den neuroflash-Support ĂŒber die App
  • FĂŒgen Sie bei der Meldung von Problemen den x-request-id-Header aus der API-Antwort bei — siehe Debugging fĂŒr Details