openapi: 3.0.3 info: title: HTML2Anything API description: | API to convert HTML to various formats including PDF, PNG, JPEG, and WebP. Simply send HTML content along with your desired output format, and receive the converted file. version: 1.0.0 contact: name: API Support license: name: MIT servers: - url: http://localhost:8080 description: Local development server - url: https://your-production-domain.com description: Production server tags: - name: Conversion description: HTML conversion operations - name: Health description: Health check endpoint paths: /convert: post: tags: - Conversion summary: Convert HTML to specified format description: | Converts HTML content to PDF, PNG, JPEG, or WebP format. Supports various options for customizing the output including: - PDF: Page format, margins, background printing - Images: Viewport size, full page capture, quality settings operationId: convertHtml requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConversionRequest' examples: pdfConversion: summary: Convert to PDF value: html: "

Hello World

This is a test document.

" format: "pdf" options: format: "A4" printBackground: true margin: top: "20px" right: "20px" bottom: "20px" left: "20px" pngConversion: summary: Convert to PNG value: html: "

Hello World

This is a test image.

" format: "png" options: fullPage: true viewport: width: 1920 height: 1080 jpegConversion: summary: Convert to JPEG value: html: "

Hello World

" format: "jpeg" options: quality: 90 fullPage: false webpConversion: summary: Convert to WebP value: html: "

WebP Image

" format: "webp" options: fullPage: true responses: '200': description: Successful conversion content: application/pdf: schema: type: string format: binary image/png: schema: type: string format: binary image/jpeg: schema: type: string format: binary image/webp: schema: type: string format: binary '400': description: Validation error content: application/json: schema: $ref: '#/components/schemas/ValidationError' example: error: "Validation error" details: "\"format\" must be one of [pdf, png, jpeg, webp]" '500': description: Conversion failed content: application/json: schema: $ref: '#/components/schemas/ConversionError' example: error: "Conversion failed" message: "Failed to render page" /health: get: tags: - Health summary: Health check description: Check if the API is running and healthy operationId: healthCheck responses: '200': description: API is healthy content: application/json: schema: $ref: '#/components/schemas/HealthResponse' example: status: "ok" components: schemas: ConversionRequest: type: object required: - html - format properties: html: type: string description: HTML content to convert example: "

Hello World

" format: type: string enum: - pdf - png - jpeg - webp description: Output format example: "pdf" options: type: object description: Format-specific conversion options properties: # PDF-specific options format: type: string description: PDF page format (PDF only) example: "A4" enum: - Letter - Legal - Tabloid - Ledger - A0 - A1 - A2 - A3 - A4 - A5 - A6 printBackground: type: boolean description: Print background graphics (PDF only) default: true margin: type: object description: Page margins (PDF only) properties: top: type: string example: "20px" right: type: string example: "20px" bottom: type: string example: "20px" left: type: string example: "20px" # Image-specific options fullPage: type: boolean description: Capture full page (Images only) default: true quality: type: integer description: Image quality 0-100 (JPEG only) minimum: 0 maximum: 100 example: 90 viewport: type: object description: Viewport dimensions properties: width: type: integer description: Viewport width in pixels example: 1920 height: type: integer description: Viewport height in pixels example: 1080 ValidationError: type: object properties: error: type: string example: "Validation error" details: type: string example: "\"html\" is required" ConversionError: type: object properties: error: type: string example: "Conversion failed" message: type: string example: "Failed to render page" HealthResponse: type: object properties: status: type: string example: "ok"