openapi: 3.0.3 info: title: Render Genie API version: 1.0.0 description: | # Render Genie - Webpage Rendering API Capture screenshots (PNG, JPEG), generate PDFs, or extract HTML from any webpage with a single API call. ## Features - **Multiple Formats**: PNG, JPEG, PDF, HTML - **Custom Viewports**: Define exact width and height - **Full Page Capture**: Capture entire scrollable pages - **Wait Conditions**: Control when rendering occurs (load, DOMContentLoaded, networkidle) - **User Agent Control**: Desktop, mobile, or custom user agents ## Authentication Authentication is handled automatically by RapidAPI. Simply include your RapidAPI key in the `X-RapidAPI-Key` header (done automatically when using the RapidAPI interface or code snippets). ## Rate Limits Rate limits vary by subscription tier. Check your RapidAPI dashboard for current usage. termsOfService: https://rendergenie.lovable.app/terms contact: name: Render Genie Support url: https://rendergenie.lovable.app/support email: support@rendergenie.app license: name: Proprietary url: https://rendergenie.lovable.app/terms servers: - url: https://render-genie.p.rapidapi.com description: Render Genie API Server tags: - name: System description: Service health and status endpoints - name: Render description: Webpage rendering operations paths: /render: get: summary: Health Check description: | Returns the current status of the Render Genie API service. Use this endpoint for monitoring and uptime checks. operationId: healthCheck tags: - System security: [] responses: '200': description: Service is operational content: application/json: schema: $ref: '#/components/schemas/HealthCheckResponse' example: status: ok service: Render Genie API version: 1.0.0 timestamp: 1706745600000 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Internal server error code: INTERNAL_ERROR statusCode: 500 post: summary: Render Webpage description: | Capture a screenshot, generate a PDF, or extract HTML from any publicly accessible webpage. ## Output Formats - **png**: PNG image (base64 encoded) - **jpeg**: JPEG image (base64 encoded) - **pdf**: PDF document (base64 encoded) - **html**: Raw HTML string ## Viewport Default viewport is 1280x720. Specify custom dimensions for responsive testing. ## Wait Conditions - `load`: Wait for the load event - `domcontentloaded`: Wait for DOMContentLoaded event - `networkidle`: Wait until no network requests for 500ms operationId: renderWebpage tags: - Render requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RenderRequest' examples: basicScreenshot: summary: Basic PNG Screenshot description: Capture a simple PNG screenshot with default settings value: url: https://example.com format: png fullPagePDF: summary: Full Page PDF description: Generate a PDF of the entire scrollable page value: url: https://example.com format: pdf fullPage: true mobileViewport: summary: Mobile Viewport Screenshot description: Capture a screenshot at mobile dimensions value: url: https://example.com format: jpeg viewport: width: 375 height: 812 userAgent: mobile htmlExtraction: summary: HTML Extraction description: Extract the rendered HTML DOM value: url: https://example.com format: html waitUntil: networkidle responses: '200': description: Render completed successfully content: application/json: schema: $ref: '#/components/schemas/RenderResponse' examples: imageResponse: summary: Image Response (PNG/JPEG) value: success: true format: png base64: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg== metadata: width: 1280 height: 720 renderTime: 1523 timestamp: 1706745600000 pdfResponse: summary: PDF Response value: success: true format: pdf base64: JVBERi0xLjcKCjEgMCBvYmoKPDwKL1R5cGUgL0NhdGFsb2cKL1BhZ2VzIDIgMCBSCj4+CmVuZG9iago= metadata: width: 1280 height: 720 renderTime: 2150 timestamp: 1706745600000 htmlResponse: summary: HTML Response value: success: true format: html dom: Example

Hello World

metadata: width: 1280 height: 720 renderTime: 890 timestamp: 1706745600000 '400': description: Bad request - Invalid parameters content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Invalid URL format code: INVALID_URL statusCode: 400 '429': description: Too many requests - Rate limit exceeded content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Rate limit exceeded. Please upgrade your plan or try again later. code: RATE_LIMIT_EXCEEDED statusCode: 429 '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Internal server error code: INTERNAL_ERROR statusCode: 500 '502': description: Bad gateway - Rendering service unavailable content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: success: false error: Rendering service temporarily unavailable code: RENDER_SERVICE_UNAVAILABLE statusCode: 502 components: schemas: HealthCheckResponse: type: object required: - status - service - version - timestamp properties: status: type: string description: Service status enum: - ok example: ok service: type: string description: Service name example: Render Genie API version: type: string description: API version example: 1.0.0 timestamp: type: integer format: int64 description: Unix timestamp in milliseconds example: 1706745600000 RenderRequest: type: object required: - url - format properties: url: type: string format: uri description: The URL of the webpage to render. Must be publicly accessible. example: https://example.com format: type: string description: Output format for the render enum: - png - jpeg - pdf - html example: png fullPage: type: boolean description: Capture the full scrollable page instead of just the viewport default: false example: false viewport: $ref: '#/components/schemas/Viewport' waitUntil: type: string description: When to consider the page loaded enum: - load - domcontentloaded - networkidle default: load example: load userAgent: type: string description: User agent type or custom string enum: - desktop - mobile - custom default: desktop example: desktop customUserAgent: type: string description: Custom user agent string (only used when userAgent is 'custom') example: Mozilla/5.0 (Custom Bot) Viewport: type: object description: Viewport dimensions for rendering properties: width: type: integer minimum: 320 maximum: 3840 description: Viewport width in pixels default: 1280 example: 1280 height: type: integer minimum: 240 maximum: 2160 description: Viewport height in pixels default: 720 example: 720 RenderResponse: type: object required: - success - format - metadata properties: success: type: boolean description: Whether the render was successful example: true format: type: string description: The format of the rendered output enum: - png - jpeg - pdf - html example: png base64: type: string description: Base64-encoded content (for png, jpeg, pdf formats) example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg== dom: type: string description: HTML content (for html format) example: ... metadata: $ref: '#/components/schemas/RenderMetadata' error: type: string description: Error message if success is false example: null RenderMetadata: type: object required: - width - height - renderTime - timestamp description: Metadata about the render operation properties: width: type: integer description: Rendered viewport width in pixels example: 1280 height: type: integer description: Rendered viewport height in pixels example: 720 renderTime: type: integer description: Time taken to render in milliseconds example: 1523 timestamp: type: integer format: int64 description: Unix timestamp when render completed (milliseconds) example: 1706745600000 ErrorResponse: type: object required: - success - error - code - statusCode properties: success: type: boolean description: Always false for error responses enum: - false example: false error: type: string description: Human-readable error message example: Invalid URL format code: type: string description: Machine-readable error code enum: - INVALID_URL - INVALID_FORMAT - INVALID_VIEWPORT - MISSING_URL - RATE_LIMIT_EXCEEDED - INTERNAL_ERROR - RENDER_SERVICE_UNAVAILABLE - RENDER_FAILED example: INVALID_URL statusCode: type: integer description: HTTP status code example: 400