Error Codes

{
  "error": "error_code",
  "message": "Human-readable description of the error.",
  "details": {
    // Additional context (optional)
  }
}

{
  "error": "missing_api_key",
  "message": "API key is required. Include it in the X-API-Key header."
}

{
  "error": "invalid_api_key",
  "message": "The API key provided is invalid or has been revoked."
}

{
  "error": "invalid_request",
  "message": "The request body is not valid JSON."
}

{
  "error": "missing_field",
  "message": "The 'text' field is required.",
  "details": {
    "field": "text"
  }
}

{
  "error": "text_too_long",
  "message": "Text exceeds maximum length of 10,000 characters.",
  "details": {
    "max_length": 10000,
    "actual_length": 15234
  }
}

{
  "error": "invalid_mode",
  "message": "Invalid verification mode. Use 'blocking', 'flagging', or 'logging'.",
  "details": {
    "provided": "strict",
    "valid_modes": ["blocking", "flagging", "logging"]
  }
}

{
  "error": "insufficient_permissions",
  "message": "Your API key does not have permission for this action.",
  "details": {
    "required_scope": "keys:write",
    "current_scopes": ["verify", "harm_detect"]
  }
}

{
  "error": "quota_exceeded",
  "message": "You have exceeded your monthly verification limit.",
  "details": {
    "current_usage": 50000,
    "monthly_limit": 50000,
    "resets_at": "2024-02-01T00:00:00Z"
  }
}

{
  "error": "rate_limit_exceeded",
  "message": "You have exceeded your rate limit of 200 requests per minute.",
  "details": {
    "limit": 200,
    "window": "1 minute",
    "retry_after": 45
  }
}

Retry-After: 45
X-RateLimit-Limit: 200
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1705765200

{
  "error": "internal_error",
  "message": "An unexpected error occurred. Please try again.",
  "details": {
    "request_id": "req_abc123"
  }
}

{
  "error": "service_unavailable",
  "message": "The service is temporarily unavailable. Please try again later.",
  "details": {
    "retry_after": 60
  }
}

import requests
 
def verify_text(text: str) -> dict:
    response = requests.post(
        "https://api.glyphnet.io/v1/verify",
        headers={"X-API-Key": API_KEY},
        json={"text": text}
    )
 
    if response.status_code == 200:
        return response.json()
 
    error = response.json()
 
    if response.status_code == 429:
        retry_after = int(response.headers.get("Retry-After", 60))
        raise RateLimitError(f"Rate limited. Retry after {retry_after}s")
 
    if response.status_code == 401:
        raise AuthenticationError(error["message"])
 
    if response.status_code == 400:
        raise ValidationError(error["message"])
 
    raise APIError(f"API error: {error['message']}")

async function verifyText(text) {
  const response = await fetch('https://api.glyphnet.io/v1/verify', {
    method: 'POST',
    headers: {
      'X-API-Key': API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({ text })
  });
 
  if (response.ok) {
    return response.json();
  }
 
  const error = await response.json();
 
  switch (response.status) {
    case 429:
      const retryAfter = response.headers.get('Retry-After') || 60;
      throw new RateLimitError(`Rate limited. Retry after ${retryAfter}s`);
    case 401:
      throw new AuthenticationError(error.message);
    case 400:
      throw new ValidationError(error.message);
    default:
      throw new APIError(`API error: ${error.message}`);
  }
}