{ "openapi": "3.0.0", "info": { "title": "Image and PDF Generation API", "description": "API for generating images and PDFs from URLs or HTML content", "version": "1.0.0" }, "servers": [ { "url": "https://pdfmunk.com/api", "description": "Production Server" }, { "url": "http://127.0.0.1:5000", "description": "Local Development Server" } ], "paths": { "/v1/generateImage": { "post": { "summary": "Generate an image from a URL or HTML content", "description": "Creates an image based on the provided URL or HTML content", "operationId": "generateImage", "tags": [ "Image Generation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UrlImageRequest" }, { "$ref": "#/components/schemas/HtmlImageRequest" } ] }, "examples": { "URL Image Generation": { "value": { "source_type": "url", "url": "https://google.com" } }, "HTML Image Generation": { "value": { "source_type": "html", "html_content": "

Hello World

" } } } } } }, "responses": { "200": { "description": "Image generated successfully", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UrlResponse" }, { "$ref": "#/components/schemas/Base64Response" }, { "$ref": "#/components/schemas/BothResponse" } ] } }, "image/png": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/v1/generatePdf": { "post": { "summary": "Generate PDF from URL or HTML content", "description": "Converts a URL or HTML/CSS content to a PDF file with customizable options. PDFs are temporarily stored for 30 days.", "operationId": "generatePdf", "tags": [ "PDF Generation" ], "requestBody": { "description": "PDF generation parameters", "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UrlToPdfRequest" }, { "$ref": "#/components/schemas/HtmlToPdfRequest" } ] }, "examples": { "URL conversion": { "value": { "url": "https://google.com" } }, "HTML conversion": { "value": { "html_content": "

Hello World

" } } } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SuccessResponse" }, "example": { "file_deletion_date": "2025-04-28", "file_size_bytes": 188321, "pages": 5, "pdf_url": "https://google.com/generated.pdf", "success": true } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } }, "examples": { "No input": { "value": { "error": "No input provided", "success": false } }, "Invalid page_size": { "value": { "error": "Maximum allowed page_size is 20", "success": false } }, "Missing required data": { "value": { "error": "No URL or HTML content provided", "success": false } }, "File too large": { "value": { "error": "Generated PDF exceeds maximum size of 3MB", "success": false } } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "examples": { "General error": { "value": { "error": "An unexpected error occurred", "success": false } }, "Upload failure": { "value": { "error": "Failed to upload PDF to storage", "success": false } } } } } } } } }, "/health": { "get": { "summary": "Health Check", "description": "Checks the health of the API", "operationId": "healthCheck", "tags": [ "Health Check" ], "responses": { "200": { "description": "API is healthy", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "example": "ok" } } } } } } } } } }, "components": { "schemas": { "UrlImageRequest": { "type": "object", "required": [ "source_type", "url" ], "properties": { "source_type": { "type": "string", "enum": [ "url" ], "description": "Type of source for image generation", "default": "url" }, "url": { "type": "string", "description": "URL from which to generate an image", "default": "https://google.com" } } }, "HtmlImageRequest": { "type": "object", "required": [ "source_type", "html_content" ], "properties": { "source_type": { "type": "string", "enum": [ "html" ], "description": "Type of source for image generation" }, "html_content": { "type": "string", "description": "HTML content to render as an image" } } }, "UrlResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the request was successful" }, "file_size_bytes": { "type": "integer", "description": "Size of the generated image in bytes" }, "image_url": { "type": "string", "description": "URL to the generated image" }, "file_deletion_date": { "type": "string", "format": "date", "description": "Date when the file will be deleted" } } }, "Base64Response": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the request was successful" }, "file_size_bytes": { "type": "integer", "description": "Size of the generated image in bytes" }, "image_base64": { "type": "string", "description": "Base64 encoded image data" } } }, "BothResponse": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the request was successful" }, "file_size_bytes": { "type": "integer", "description": "Size of the generated image in bytes" }, "image_url": { "type": "string", "description": "URL to the generated image" }, "file_deletion_date": { "type": "string", "format": "date", "description": "Date when the file will be deleted" }, "image_base64": { "type": "string", "description": "Base64 encoded image data" } } }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Error message" }, "success": { "type": "boolean", "description": "Always false in case of error" } } }, "UrlToPdfRequest": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL to convert to PDF", "example": "https://google.com" } } }, "HtmlToPdfRequest": { "type": "object", "required": [ "html_content" ], "properties": { "html_content": { "type": "string", "description": "HTML content to convert to PDF", "example": "

Hello World

This is a test.

" } } }, "SuccessResponse": { "type": "object", "properties": { "pdf_url": { "type": "string", "description": "URL to access the generated PDF", "example": "https://google.com/generated.pdf" }, "success": { "type": "boolean", "description": "Whether the operation was successful", "example": true }, "file_size_bytes": { "type": "integer", "description": "Size of the generated PDF in bytes", "example": 188321 }, "pages": { "type": "integer", "description": "Number of pages in the generated PDF", "example": 5 }, "file_deletion_date": { "type": "string", "format": "date", "description": "Date when the file will be automatically deleted (30 days from creation)", "example": "2025-04-28" } } } } }, "tags": [ { "name": "Image Generation", "description": "Operations related to Image generation" }, { "name": "PDF Generation", "description": "Operations related to PDF generation" }, { "name": "Health Check", "description": "API health check" } ] }