Error Handling Overview

​

Common Error Responses

​

Authentication Errors

{
  "detail": "Authentication required. Provide Authorization: Bearer <token> header (OAuth 2.1) or X-API-Key header."
}

​

Template Required

{
  "requires_template": true,
  "message": "Please select a template from the list below",
  "available_templates": [...],
  "default_template_id": null
}

​

Credit/Quota Exceeded

{
  "error": "Insufficient credits",
  "error_code": "CREDITS_EXHAUSTED"
}

​

Generation Failed

{
  "status": "failed",
  "error": "Content generation failed",
  "details": {...}
}

• Check document format is supported (PDF, DOCX, TXT, MD)
• Verify document is not corrupted
• Try with simpler instructions
• Check document size (keep under 50MB)
• Contact support if issue persists

​

Invalid File Type

{
  "detail": "Invalid file type. Only .pptx and .ppt files are allowed."
}

• Ensure you’re uploading a PowerPoint template file (.pptx or .ppt)
• Check file extension matches the actual file type
• Re-save the file in PowerPoint format if needed

​

File Too Large

{
  "detail": "File size exceeds maximum allowed size of 50MB"
}

• Reduce file size by compressing images
• Remove unnecessary content
• Split large documents into smaller files
• Use document optimization tools

​

Template Not Found

{
  "detail": "Template not found"
}

• Verify the template ID is correct
• Check that the template belongs to your account
• List templates to see available template IDs
• Ensure the template hasn’t been deleted

​

Rate Limit Exceeded

{
  "detail": "Rate limit exceeded",
  "retry_after": 60
}

• Wait for the specified time before retrying
• Check your subscription tier limits
• Implement exponential backoff in your code
• Consider upgrading your plan for higher limits

​

Status Polling

​

Best Practices

• Always Check Status: Don’t assume generation succeeded
• Handle Timeouts: Set maximum wait times for async operations
• Retry Logic: Implement retry logic for transient errors
• Error Logging: Log errors for debugging
• User Feedback: Provide clear error messages to users

​

Error Codes