API-Referenz

Basis-URL

Jede Anfrage geht an:

Authentifizierung

Erstelle einen Schlüssel auf der Seite API-Schlüssel und sende ihn als Bearer-Token im Authorization-Header. Es wird nur ein Hash deines Schlüssels gespeichert — kopiere ihn direkt bei der Erstellung, denn GatifyAI kann ihn dir danach nicht mehr anzeigen.

Schnellstart

Eine minimale Anfrage in curl, Python oder TypeScript:

curl https://gatifyai.com/api/v1/chat/completions \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "MODEL_NAME",
    "messages": [{"role": "user", "content": "Hello!"}]
  }'

Einen Schlüssel auf bestimmte Modelle beschränken

Standardmäßig kann ein neuer Schlüssel jedes kostenlose Modell von GatifyAI nutzen, mit demselben automatischen Fallback wie im Web-Chat, falls eines nicht verfügbar ist. Du kannst einen Schlüssel stattdessen auf ein bestimmtes Modell oder eine kurze Liste beschränken — der Schlüssel nutzt dann ausschließlich Modelle aus dieser Liste, in der von dir angegebenen Reihenfolge, unabhängig davon, welches Modell eine Anfrage verlangt. Eine Anfrage nach einem Modell außerhalb dieser Liste liefert einen 400-Fehler mit den tatsächlich erlaubten Modellen.

Mit einer Persona chatten

Übergib model: "persona/<slug>", um mit einer im Community-Galerie veröffentlichten Persona zu chatten — ihre Persönlichkeit und bevorzugten Modelle werden automatisch verwendet, weiterhin eingeschränkt durch die erlaubten Modelle deines Schlüssels, falls gesetzt. Den Slug einer Persona und ein fertiges Beispiel findest du auf ihrer eigenen Seite, im API-Tab.

{
  "model": "persona/senior-engineer",
  "messages": [{"role": "user", "content": "Review my code."}]
}

Streaming vs. nicht-Streaming

Setze stream: true, um Tokens zu erhalten, sobald sie generiert werden, genau wie im OpenAI-Streaming-Format (Server-Sent Events, beendet durch [DONE]). Lass es weg oder setze es auf false, um auf die vollständige Antwort zu warten und eine einzelne JSON-Antwort zu erhalten — das ist die Standardeinstellung.

Fehler

Fehler folgen dem OpenAI-Fehlerformat: {"error": {"message": "...", "type": "..."}}. Ein 401 bedeutet einen fehlenden, ungültigen oder widerrufenen Schlüssel. Ein 400 bedeutet, dass die Anfrage selbst ungültig ist — meistens ein unbekanntes Modell, ein nicht veröffentlichter/unbekannter Persona-Slug oder ein Modell außerhalb der erlaubten Liste deines Schlüssels. Ein 502 bedeutet, dass kein infrage kommendes Modell geantwortet hat.

{
  "error": {
    "message": "This API key may only use: llama-3.1-8b:free",
    "type": "invalid_request_error"
  }
}

Ratenbegrenzung

API-Anfragen zählen zum selben kontobezogenen Chat-Ratenlimit wie die Web-App — es gibt derzeit kein separates Kontingent für API-Traffic.