API referenceGET

Keyword change usage

Check the monthly keyword edit allowance for the account, how much is used, and how much remains.

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

Check the monthly keyword edit allowance for the account, how much is used, and how much remains.

Bearer Token (RedReplier API token)

Parameters

This endpoint does not take path or query parameters.

Request body

This endpoint does not require a JSON body.

Response

Returns current keyword edit usage.

  • limit (number): Monthly keyword edit allowance; -1 means unlimited.
  • used (number): Keyword edits used this month.
  • remaining (number): Keyword edits remaining this month; -1 means unlimited.
  • unlimited (boolean): Whether the allowance is unlimited.

Notes

Keyword edits are unlimited on every current plan, so this returns limit: -1, used: 0, remaining: -1 and unlimited: true. It stays for clients that budget edits. Adding, disabling, enabling and deleting keywords never counted.

Errors

  • 400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
  • 401 Unauthorized: Missing or invalid Bearer token, or code: "token_issuer_lost_access" when the person who created the API key was deactivated or left the workspace.
  • 403 Forbidden: code: "subscription_required" when the workspace plan does not include API access, code: "workspace_access_denied" when X-Workspace-Id names a workspace this credential cannot reach, or code: "permission_denied" when your role in the workspace does not hold redreplier.write (Admin and Editor hold it).
  • 404 Not Found: The resource does not exist for the token account.
  • 429 Too Many Requests: Rate limit exceeded. Wait the seconds in Retry-After.
  • 500 Internal Server Error: Unexpected server error.
Example request (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
}