API-ReferenzGET

Keyword-Edit-Nutzung

Prüft das monatliche Keyword-Edit-Kontingent und die aktuelle Nutzung.

GEThttps://ai.redreplier.com/ai-app/api/v1/keywords/change-usage

Prüft das monatliche Keyword-Edit-Kontingent und die aktuelle Nutzung.

Bearer-Token (RedReplier-API-Token)

Parameter

Dieser Endpoint hat keine Pfad- oder Query-Parameter.

Request-Body

Dieser Endpoint benötigt keinen JSON-Body.

Antwort

Gibt die aktuelle Keyword-Edit-Nutzung zurück.

  • limit (number): Monatliches Keyword-Edit-Kontingent; -1 bedeutet unbegrenzt.
  • used (number): In diesem Monat genutzte Keyword-Edits.
  • remaining (number): Verbleibende Keyword-Edits in diesem Monat; -1 bedeutet unbegrenzt.
  • unlimited (boolean): Gibt an, ob das Kontingent unbegrenzt ist.

Hinweise

Keyword-Bearbeitungen sind in jedem aktuellen Tarif unbegrenzt, daher liefert der Endpoint limit: -1, used: 0, remaining: -1 und unlimited: true. Er bleibt für Clients, die Bearbeitungen budgetieren. Hinzufügen, Deaktivieren, Aktivieren und Löschen haben nie gezählt.

Fehler

  • 400 Bad Request: Ungültige Eingabe, URL, UUID, Enum, Query-Parameter oder Body.
  • 401 Unauthorized: Fehlendes oder ungültiges Bearer-Token, oder code: "token_issuer_lost_access", wenn die Person, die den API-Schlüssel erstellt hat, deaktiviert wurde oder den Workspace verlassen hat.
  • 403 Forbidden: code: "subscription_required", wenn der Tarif des Workspace keinen API-Zugang enthält, code: "workspace_access_denied", wenn X-Workspace-Id einen Workspace nennt, den diese Zugangsdaten nicht erreichen, oder code: "permission_denied", wenn Ihre Rolle im Workspace die Berechtigung redreplier.write nicht hat (Admin und Editor haben sie).
  • 404 Not Found: Die Ressource existiert nicht für das Token-Konto.
  • 429 Too Many Requests: Rate-Limit überschritten. Warten Sie die Sekunden aus Retry-After ab.
  • 500 Internal Server Error: Unerwarteter Serverfehler.
Beispielanfrage (curl)
curl --request GET \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/change-usage \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "limit": -1,
  "used": 0,
  "remaining": -1,
  "unlimited": true
}