{ "openapi": "3.0.3", "info": { "title": "SarvaPDF - End-to-End PDF Workflow API", "description": "SarvaPDF unifies HTML/URL/Markdown to PDF rendering, screenshots, template-driven document generation, extraction, and PDF utilities into one API. RapidAPI customers should authenticate only through RapidAPI. Direct SarvaPDF customers should use `X-Api-Key` or approved first-party Bearer auth.", "version": "2.0.0", "x-logo": { "url": "https://sarvasoft.com/sarvapdf" } }, "paths": { "/pdf/convert": { "post": { "tags": [ "pdf", "pdf" ], "summary": "Convert content to PDF", "description": "Convert provided content (see PDFRequest model) into a PDF. Supported response modes: `binary` (raw PDF), `base64`, `json` with metadata, or `url` (store and return a download URL).", "operationId": "convert_handler_pdf_convert_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PDFRequest" }, "examples": { "invoice_with_security": { "summary": "Invoice PDF with metadata, password, compression, and image watermark", "value": { "html": "

Invoice #1042

Customer: Demo User

Total: $129.99

Shareable report

Temporary link example.

", "response_mode": "url", "filename": "shareable-report.pdf" } } } } }, "required": true }, "responses": { "200": { "description": "PDF in selected response mode", "content": { "application/json": { "schema": {}, "examples": { "json_mode": { "summary": "JSON response mode", "value": { "filename": "invoice-1042.pdf", "size": 48231, "pdf_base64": "" } }, "url_mode": { "summary": "Temporary public URL response", "value": { "filename": "shareable-report.pdf", "file_url": "https://api.sarvasoft.com/url/pdf/abc123?token=secure-token", "expires_at": "2026-03-15T18:00:00+00:00", "expires_in_seconds": 900 } } } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/extract/file": { "post": { "tags": [ "pdf", "pdf", "extract" ], "summary": "Extract text from uploaded PDF file", "description": "Multipart/form-data endpoint. Send `file` as the PDF to extract. Optional form field `structured` (boolean) to request structured extraction.", "operationId": "extract_from_file_pdf_extract_file_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_extract_from_file_pdf_extract_file_post" } } }, "required": true }, "responses": { "200": { "description": "Extraction result (model depends on service)", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/extract/base64": { "post": { "tags": [ "pdf", "pdf", "extract" ], "summary": "Extract text from base64 PDF in JSON", "description": "Provide `pdf_base64` in JSON body (PDFExtractRequest model).", "operationId": "extract_from_base64_pdf_extract_base64_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PDFExtractRequestB64" } } }, "required": true }, "responses": { "200": { "description": "Extraction result (model depends on service)", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/extract/url": { "post": { "tags": [ "pdf", "pdf", "extract" ], "summary": "Extract text from PDF at remote URL", "description": "Provide `pdf_url` in JSON body (PDFExtractRequest model).", "operationId": "extract_from_url_pdf_extract_url_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PDFExtractRequestUrl" } } }, "required": true }, "responses": { "200": { "description": "Extraction result (model depends on service)", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/extract/metadata": { "post": { "tags": [ "pdf", "pdf", "extract" ], "summary": "Extract metadata and document properties from a PDF", "description": "Extract metadata (Title, Author, Subject, Keywords, Producer, CreationDate, ModDate, etc.) from a PDF. Supports: multipart PDF upload, base64 JSON, or URL.", "operationId": "extract_metadata_pdf_extract_metadata_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_extract_metadata_pdf_extract_metadata_post" } } } }, "responses": { "200": { "description": "Metadata as JSON", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/merge": { "post": { "tags": [ "pdf", "pdf", "merge" ], "summary": "Merge multiple PDF documents", "description": "Merge PDFs from multipart upload, remote URLs or base64 list. Request can be multipart/form-data with `files` (UploadFile[]), or application/json with `pdf_urls` (list), `pdf_base64` (list), `response_mode` and `filename`.", "operationId": "merge_pdfs_pdf_merge_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_merge_pdfs_pdf_merge_post" } } } }, "responses": { "200": { "description": "Merged PDF in selected response mode", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/split": { "post": { "tags": [ "pdf", "pdf", "split" ], "summary": "Split PDF into pages", "description": "Split a PDF into separate pages. Input can be multipart file upload or application/json with `pdf_url` or `pdf_base64`. New output: use `response_mode` (binary|base64|json|url). Legacy output: `output_mode` of `zip` (default) or `array`.", "operationId": "split_pdf_pdf_split_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_split_pdf_pdf_split_post" } } } }, "responses": { "200": { "description": "Split result in selected output format", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/pdf/rotate": { "post": { "tags": [ "pdf", "pdf", "rotate" ], "summary": "Rotate pages within a PDF", "description": "Rotate pages in a PDF. Input may be file upload, `pdf_url` or `pdf_base64` in JSON. Provide `degrees` (90/180/270), optional `page_numbers` list, and `response_mode` (binary|base64|json|url).", "operationId": "rotate_pdf_pdf_rotate_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_rotate_pdf_pdf_rotate_post" } } } }, "responses": { "200": { "description": "Rotated PDF in selected response mode", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/screenshot": { "post": { "tags": [ "screenshot" ], "summary": "Capture a screenshot image from HTML or URL", "description": "Capture a PNG/JPEG screenshot rendered from `html` or `url` using the `ScreenshotRequest` schema. Supported `response_mode` values: `binary`, `base64`, `json`, `url`.\n\nBinary responses will include a `Content-Disposition` header with the suggested `filename`. JSON responses include metadata where appropriate.", "operationId": "screenshot_handler_screenshot_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotRequest" } } }, "required": true }, "responses": { "200": { "description": "Screenshot returned according to `response_mode`.", "headers": { "Content-Disposition": { "description": "Suggested attachment filename (when binary).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "filename": "example.png", "image_base64": "" } } } }, "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/screenshot/pdf": { "post": { "tags": [ "screenshot" ], "summary": "Capture screenshot then convert to PDF", "description": "Capture a PNG/JPEG screenshot (same `ScreenshotRequest` schema) and convert the image to a PDF. `response_mode` mapping:\n\n- `binary` -> `application/pdf` stream with `Content-Disposition`\n- `base64` -> `{ \"pdf_base64\": \"\" }`\n- `json` -> `{ \"size\", \"created_at\", \"pdf_base64\" }`\n- `url` -> `{ \"file_url\": \"...\" }` (saved via storage backend)", "operationId": "screenshot_to_pdf_handler_screenshot_pdf_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotRequest" } } }, "required": true }, "responses": { "200": { "description": "PDF returned according to `response_mode`.", "headers": { "Content-Disposition": { "description": "Suggested attachment filename (when binary).", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "size": 54321, "created_at": "2025-01-01T12:00:00.000000", "pdf_base64": "" } } } }, "application/pdf": {} } }, "400": { "description": "Bad request - invalid body or validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Server error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/templates/templates/{slug}": { "get": { "tags": [ "Templates" ], "summary": "Serve Template", "operationId": "serve_template_templates_templates__slug__get", "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Slug" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/templates/create": { "post": { "tags": [ "Templates" ], "summary": "Create a new user template", "description": "Create and store a user-specific Jinja2 HTML template.\n\nRequest body: `TemplateCreate` (name, html). Returns the created template metadata.", "operationId": "create_template_templates_create_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateCreate" } } }, "required": true }, "responses": { "200": { "description": "Template created; returns template metadata or confirmation.", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Bad request - invalid payload or duplicate name" }, "401": { "description": "Unauthorized - user resolution failed" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/templates/list": { "get": { "tags": [ "Templates" ], "summary": "List user templates", "description": "Return a list of templates available to the authenticated user.", "operationId": "list_templates_templates_list_get", "responses": { "200": { "description": "Array of templates for the user", "content": { "application/json": { "schema": {}, "examples": { "default": { "value": [ { "name": "invoice", "created_at": "2025-01-01T00:00:00" } ] } } } } }, "401": { "description": "Unauthorized - user resolution failed" } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/templates/get/{template_id}": { "get": { "tags": [ "Templates" ], "summary": "Get a specific template", "description": "Retrieve the stored template HTML and metadata by template ID for the current user.", "operationId": "get_template_templates_get__template_id__get", "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Template Id" } } ], "responses": { "200": { "description": "Template object", "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "name": "invoice", "html": "..." } } } } } }, "404": { "description": "Template not found" }, "401": { "description": "Unauthorized - user resolution failed" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/templates/delete/{template_id}": { "delete": { "tags": [ "Templates" ], "summary": "Delete a user template", "description": "Delete a template by ID for the authenticated user.", "operationId": "remove_template_templates_delete__template_id__delete", "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Template Id" } } ], "responses": { "200": { "description": "Deletion confirmation", "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "deleted": "tpl_abc123", "status": "ok" } } } } } }, "404": { "description": "Template not found" }, "401": { "description": "Unauthorized - user resolution failed" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/templates/preview": { "post": { "tags": [ "Templates" ], "summary": "Render a template preview", "description": "Render a stored template server-side using Jinja2 and provided `data`.\n\nRequest body: JSON with `template_id` (string) and `data` (object) containing template variables.\nResponse: `{ \"rendered_html\": \"\" }`.", "operationId": "preview_template_templates_preview_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplatePreviewRequest" } } }, "required": true }, "responses": { "200": { "description": "Rendered HTML preview", "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "rendered_html": "..." } } } } } }, "404": { "description": "Template not found" }, "401": { "description": "Unauthorized - user resolution failed" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/templates/variables/{template_id}": { "get": { "tags": [ "Templates" ], "summary": "List template variables", "description": "Analyze the stored template HTML and return a deduplicated list of Jinja2 variable tokens found in `{{ ... }}` form to help callers know what variables to supply.", "operationId": "template_variables_templates_variables__template_id__get", "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ], "parameters": [ { "name": "template_id", "in": "path", "required": true, "schema": { "type": "string", "title": "Template Id" } } ], "responses": { "200": { "description": "List of variable names", "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "template_id": "tpl_abc123", "variables": [ "customer_name", "amount_due" ] } } } } } }, "404": { "description": "Template not found" }, "401": { "description": "Unauthorized - user resolution failed" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/templates/render-pdf": { "post": { "tags": [ "Templates" ], "summary": "Render template to PDF", "description": "Render a stored Jinja2 template with provided `data` and convert the result to PDF.\n\nRequest body: `TemplateRenderRequest` (template_id, data, page/margin options, response_mode, filename, etc.).\nBehavior: uses existing `render_pdf` service to produce bytes and returns according to `response_mode`:\n\n- `binary`: returns `application/pdf` stream with `Content-Disposition` header\n- `base64`: returns `{ \"filename\": \"...\", \"pdf_base64\": \"...\" }`\n- `json`: returns `{ \"filename\": \"...\", \"size\": ..., \"pdf_base64\": \"...\" }`\n- `url`: saves via storage service and returns `{ \"file_url\": \"...\" }`", "operationId": "render_template_pdf_templates_render_pdf_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateRenderRequest" }, "examples": { "template_invoice": { "summary": "Render stored invoice template with metadata and watermark", "value": { "template_id": "tpl_1ab2cd3ef456", "data": { "customer_name": "Acme Corp", "invoice_number": "INV-2026-1042", "amount_due": "$129.99" }, "response_mode": "json", "filename": "invoice-2026-1042.pdf", "print_background": true, "title": "Invoice INV-2026-1042", "custom_metadata": { "template": "invoice", "channel": "api" }, "watermark_text": "PAID", "watermark_position": "center" } } } } }, "required": true }, "responses": { "200": { "description": "PDF returned according to response_mode", "content": { "application/json": { "schema": {}, "examples": { "default": { "value": { "filename": "invoice.pdf", "pdf_base64": "" } } } }, "application/pdf": {} } }, "400": { "description": "Bad request - unsupported response_mode or invalid payload" }, "404": { "description": "Template not found" }, "401": { "description": "Unauthorized - user resolution failed" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/status": { "get": { "summary": "Status", "operationId": "status_status_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/": { "get": { "summary": "Root Redirect", "operationId": "root_redirect__get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/health": { "get": { "summary": "Health", "operationId": "health_health_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } }, "/url/{asset_kind}/{public_slug}": { "get": { "summary": "Download generated asset", "description": "Fetch a previously generated asset using its temporary public slug and token.", "operationId": "get_rendered_pdf_url__asset_kind___public_slug__get", "parameters": [ { "name": "public_slug", "in": "path", "required": true, "schema": { "type": "string", "title": "Public Slug" } }, { "name": "asset_kind", "in": "path", "required": true, "schema": { "type": "string", "title": "Asset Kind" } }, { "name": "token", "in": "query", "required": true, "schema": { "type": "string", "title": "Token" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } }, "security": [ { "RapidAPIKey": [] }, { "InternalAPIKey": [] }, { "AuthToken": [] } ] } } }, "components": { "schemas": { "AuthType": { "type": "string", "enum": [ "none", "basic", "bearer" ], "title": "AuthType", "description": "Authentication method when fetching `url` during rendering.\n\nValues:\n- none: no authentication\n- basic: HTTP Basic Auth (username/password)\n- bearer: Bearer token in Authorization header" }, "Body_extract_from_file_pdf_extract_file_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File" }, "structured": { "type": "boolean", "title": "Structured", "default": false } }, "type": "object", "required": [ "file" ], "title": "Body_extract_from_file_pdf_extract_file_post" }, "Body_extract_metadata_pdf_extract_metadata_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File", "nullable": true } }, "type": "object", "title": "Body_extract_metadata_pdf_extract_metadata_post" }, "Body_merge_pdfs_pdf_merge_post": { "properties": { "files": { "items": { "type": "string", "format": "binary" }, "type": "array", "title": "Files", "nullable": true } }, "type": "object", "title": "Body_merge_pdfs_pdf_merge_post" }, "Body_rotate_pdf_pdf_rotate_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File", "nullable": true } }, "type": "object", "title": "Body_rotate_pdf_pdf_rotate_post" }, "Body_split_pdf_pdf_split_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File", "nullable": true } }, "type": "object", "title": "Body_split_pdf_pdf_split_post" }, "CompressionLevel": { "type": "string", "enum": [ "low", "medium", "high" ], "title": "CompressionLevel" }, "ErrorResponse": { "title": "ErrorResponse", "type": "object", "properties": { "error_code": { "title": "Error Code", "type": "integer" }, "error_description": { "title": "Error Description", "type": "string" }, "details": { "title": "Details" } }, "required": [ "error_code", "error_description" ], "additionalProperties": false }, "PDFExtractRequestB64": { "properties": { "pdf_base64": { "type": "string", "maxLength": 10000000, "title": "Pdf Base64", "description": "Base64-encoded PDF to extract from.", "nullable": true }, "structured": { "type": "boolean", "title": "Structured", "default": false } }, "additionalProperties": false, "type": "object", "title": "PDFExtractRequestB64" }, "PDFExtractRequestUrl": { "properties": { "pdf_url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Pdf Url", "description": "Public URL to a PDF to extract from.", "nullable": true }, "structured": { "type": "boolean", "title": "Structured", "default": false } }, "additionalProperties": false, "type": "object", "title": "PDFExtractRequestUrl" }, "PDFRequest": { "properties": { "html": { "type": "string", "maxLength": 1500000, "title": "Html", "description": "Raw HTML content to render to PDF.", "nullable": true }, "url": { "type": "string", "maxLength": 1500000, "minLength": 1, "format": "uri", "title": "Url", "description": "URL to navigate to and render. Mutually exclusive with `html`.", "nullable": true }, "markdown": { "type": "string", "maxLength": 1500000, "title": "Markdown", "description": "Markdown content to convert to HTML and render.", "nullable": true }, "wait_until": { "$ref": "#/components/schemas/WaitUntil", "description": "When to consider navigation finished before capturing.", "default": "networkidle" }, "custom_css": { "type": "string", "title": "Custom Css", "description": "Custom CSS to inject into the page before rendering.", "nullable": true }, "execute_javascript": { "type": "boolean", "title": "Execute Javascript", "description": "Whether to allow executing JavaScript on the page before render.", "default": true }, "header_template": { "type": "string", "title": "Header Template", "description": "HTML template for page header (printed on each page).", "nullable": true }, "footer_template": { "type": "string", "title": "Footer Template", "description": "HTML template for page footer (printed on each page).", "nullable": true }, "page_format": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Page Format", "description": "Page format / paper size, e.g. A4, Letter.", "default": "A4" }, "margin_top": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Top", "description": "Top margin (e.g. '1cm' or '10mm').", "default": "1cm" }, "margin_bottom": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Bottom", "description": "Bottom margin.", "default": "1cm" }, "margin_left": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Left", "description": "Left margin.", "default": "1cm" }, "margin_right": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Right", "description": "Right margin.", "default": "1cm" }, "timeout": { "type": "integer", "maximum": 180000.0, "minimum": 1000.0, "title": "Timeout", "description": "Navigation/render timeout in milliseconds.", "default": 30000 }, "auth_type": { "$ref": "#/components/schemas/AuthType", "description": "Authentication type to use when fetching `url`.", "default": "none" }, "auth_credentials": { "type": "string", "maxLength": 2048, "title": "Auth Credentials", "description": "Credentials payload (format depends on `auth_type`).", "nullable": true }, "extra_headers": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Extra Headers", "description": "Extra HTTP headers to use when fetching `url`.", "nullable": true }, "response_mode": { "$ref": "#/components/schemas/ResponseMode", "description": "How to return the generated PDF: binary/base64/json/url.", "default": "binary" }, "filename": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Filename", "description": "Suggested filename for the generated PDF; used in Content-Disposition for binary responses.", "default": "document.pdf" }, "scripts": { "items": { "type": "string" }, "type": "array", "title": "Scripts", "description": "List of URLs or inline scripts to inject before rendering.", "nullable": true }, "cookies": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array", "title": "Cookies", "description": "List of cookie dicts to set in the browser session before navigation.", "nullable": true }, "print_background": { "type": "boolean", "title": "Print Background", "description": "Whether to print CSS backgrounds.", "default": true }, "landscape": { "type": "boolean", "title": "Landscape", "description": "Render PDF in landscape orientation.", "default": false }, "scale": { "type": "number", "title": "Scale", "description": "Scale factor for rendering (0.1\u20132.0 typical).", "default": 1.0 }, "media_type": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Media Type", "description": "CSS media type to emulate (screen/print).", "default": "screen" }, "prefer_css_page_size": { "type": "boolean", "title": "Prefer Css Page Size", "description": "Use CSS @page sizes if available.", "default": false }, "page_ranges": { "type": "string", "maxLength": 64, "title": "Page Ranges", "description": "Page ranges to include (e.g. '1-3,5').", "nullable": true }, "sanitize_html": { "type": "boolean", "title": "Sanitize Html", "description": "If true, perform HTML sanitization before rendering (can remove scripts/styles).", "default": false }, "auto_page_numbers": { "type": "boolean", "title": "Auto Page Numbers", "description": "Enable automatic page numbers added to footer/header.", "default": false }, "page_number_template": { "type": "string", "maxLength": 128, "title": "Page Number Template", "description": "Template for page numbers.", "default": "{{page}} / {{totalPages}}", "nullable": true }, "page_number_alignment": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Page Number Alignment", "description": "Alignment for page numbers (left/center/right).", "default": "center", "nullable": true }, "page_number_color": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Page Number Color", "description": "Hex color for page numbers.", "default": "#444444", "nullable": true }, "page_number_font_size": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Page Number Font Size", "description": "Font size for page numbers.", "default": "10px", "nullable": true }, "width": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Width", "description": "Optional custom page width (px or CSS units).", "nullable": true }, "height": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Height", "description": "Optional custom page height.", "nullable": true }, "page_size": { "type": "string", "maxLength": 32, "title": "Page Size", "description": "Explicit page size name if different from page_format.", "nullable": true }, "wait_for_selector": { "type": "string", "maxLength": 256, "title": "Wait For Selector", "description": "CSS selector to wait for before rendering.", "nullable": true }, "wait_for_timeout": { "type": "integer", "maximum": 300000.0, "minimum": 0.0, "title": "Wait For Timeout", "description": "Timeout (ms) when waiting for selector/function.", "nullable": true }, "wait_for_function": { "type": "string", "maxLength": 200000, "title": "Wait For Function", "description": "JavaScript function to evaluate and wait for truthiness.", "nullable": true }, "script_url": { "type": "string", "title": "Script Url", "description": "URL to a JS file to include before rendering.", "nullable": true }, "script_file": { "type": "string", "title": "Script File", "description": "Path to a local JS file to include (if supported by deployment).", "nullable": true }, "style_url": { "type": "string", "maxLength": 2048, "title": "Style Url", "description": "URL to a CSS file to include.", "nullable": true }, "style_file": { "type": "string", "maxLength": 4096, "title": "Style File", "description": "Path to a local CSS file to include (if supported).", "nullable": true }, "password": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Password", "description": "Password to apply to generated PDF (if encryption supported).", "nullable": true }, "title": { "type": "string", "maxLength": 100, "title": "Title", "description": "Optional PDF title metadata.", "nullable": true }, "author": { "type": "string", "maxLength": 100, "title": "Author", "description": "Optional PDF author metadata.", "nullable": true }, "subject": { "type": "string", "maxLength": 100, "title": "Subject", "description": "Optional PDF subject metadata.", "nullable": true }, "keywords": { "items": { "type": "string" }, "type": "array", "title": "Keywords", "description": "Optional keywords list.", "nullable": true }, "creator": { "type": "string", "maxLength": 100, "title": "Creator", "description": "Optional creator metadata.", "nullable": true }, "producer": { "type": "string", "maxLength": 100, "title": "Producer", "description": "Optional producer metadata.", "nullable": true }, "custom_metadata": { "additionalProperties": true, "type": "object", "title": "Custom Metadata", "description": "Arbitrary key/value metadata to embed in PDF if supported.", "nullable": true }, "compress": { "type": "boolean", "title": "Compress", "description": "Whether to compress embedded images/content.", "default": false }, "compression_level": { "$ref": "#/components/schemas/CompressionLevel", "nullable": true }, "compress_quality": { "type": "integer", "maximum": 95.0, "minimum": 30.0, "title": "Compress Quality", "description": "Image downscale quality (approx. 30\u201395).", "nullable": true }, "watermark_text": { "type": "string", "maxLength": 1024, "title": "Watermark Text", "description": "Text watermark to render on pages.", "nullable": true }, "watermark_font_size": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Watermark Font Size", "description": "Font size for text watermark.", "default": 40, "nullable": true }, "watermark_color": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Watermark Color", "description": "Color for watermark text.", "default": "#000000", "nullable": true }, "watermark_opacity": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Watermark Opacity", "description": "Opacity for watermark (0.0\u20131.0).", "default": 0.15, "nullable": true }, "watermark_rotation": { "type": "integer", "maximum": 360.0, "minimum": 0.0, "title": "Watermark Rotation", "description": "Rotation angle for watermark in degrees.", "default": 45, "nullable": true }, "watermark_position": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Watermark Position", "description": "Position for watermark (e.g. center/top-left).", "default": "center", "nullable": true }, "watermark_image_url": { "type": "string", "maxLength": 2048, "title": "Watermark Image Url", "description": "Public URL to an image used as watermark.", "nullable": true }, "watermark_image_scale": { "type": "number", "maximum": 10.0, "minimum": 0.1, "title": "Watermark Image Scale", "description": "Scale factor to resize image watermark.", "default": 1.0, "nullable": true }, "watermark_image_rotation": { "type": "integer", "maximum": 360.0, "minimum": 0.0, "title": "Watermark Image Rotation", "description": "Rotation for image watermark in degrees.", "default": 45, "nullable": true }, "watermark_image_opacity": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Watermark Image Opacity", "description": "Opacity for image watermark (0.0\u20131.0).", "default": 0.15, "nullable": true } }, "additionalProperties": false, "type": "object", "title": "PDFRequest", "example": { "html": "

Invoice #1042

Customer: Demo User

Total: $129.99

", "response_mode": "json", "filename": "invoice-1042.pdf", "page_format": "A4", "print_background": true, "title": "Invoice 1042", "author": "SarvaPDF", "subject": "Billing", "keywords": [ "invoice", "billing", "sarvapdf" ], "custom_metadata": { "flow": "billing", "environment": "production" }, "compress": true, "compression_level": "high", "compress_quality": 70, "watermark_image_url": "https://sarvasoft.com/logo.png", "watermark_position": "bottom-right", "watermark_image_scale": 0.4, "password": "Invoice2026!" } }, "ResponseMode": { "type": "string", "enum": [ "binary", "base64", "json", "url" ], "title": "ResponseMode", "description": "How the API should return the generated asset.\n\nValues:\n- binary: direct binary stream (e.g. image/* or application/pdf)\n- base64: small JSON object containing base64 payload\n- json: JSON with metadata + base64 payload\n- url: save to storage backend and return a public URL" }, "ScreenshotRequest": { "properties": { "html": { "type": "string", "maxLength": 500000, "title": "Html", "description": "Raw HTML to render for the screenshot.", "nullable": true }, "url": { "type": "string", "maxLength": 2083, "minLength": 1, "format": "uri", "title": "Url", "description": "URL to navigate to for screenshot capture.", "nullable": true }, "markdown": { "type": "string", "maxLength": 500000, "title": "Markdown", "description": "Markdown to convert to HTML and render.", "nullable": true }, "width": { "type": "integer", "maximum": 10000.0, "minimum": 100.0, "title": "Width", "description": "Viewport width in pixels.", "default": 1280 }, "height": { "type": "integer", "maximum": 10000.0, "minimum": 100.0, "title": "Height", "description": "Viewport height in pixels.", "default": 720 }, "full_page": { "type": "boolean", "title": "Full Page", "description": "Capture the full vertically scrollable page when true.", "default": false }, "custom_css": { "type": "string", "maxLength": 200000, "title": "Custom Css", "description": "Custom CSS to inject before capture.", "nullable": true }, "execute_javascript": { "type": "boolean", "title": "Execute Javascript", "description": "Allow JavaScript evaluation before capture.", "default": true }, "wait_until": { "$ref": "#/components/schemas/WaitUntil", "description": "When to consider the page ready before capture.", "default": "networkidle" }, "timeout": { "type": "integer", "maximum": 180000.0, "minimum": 1000.0, "title": "Timeout", "description": "Navigation/render timeout in milliseconds.", "default": 30000 }, "wait_for_selector": { "type": "string", "maxLength": 256, "title": "Wait For Selector", "description": "CSS selector to wait for before capture.", "nullable": true }, "wait_for_timeout": { "type": "integer", "maximum": 300000.0, "minimum": 0.0, "title": "Wait For Timeout", "description": "Timeout for selector/function waits in milliseconds.", "nullable": true }, "wait_for_function": { "type": "string", "maxLength": 200000, "title": "Wait For Function", "description": "JavaScript condition to wait for before capture.", "nullable": true }, "scripts": { "items": { "type": "string" }, "type": "array", "title": "Scripts", "description": "Inline scripts or remote script URLs to inject before capture.", "nullable": true }, "script_url": { "type": "string", "maxLength": 2048, "title": "Script Url", "description": "Remote script URL to inject before capture.", "nullable": true }, "script_file": { "type": "string", "maxLength": 4096, "title": "Script File", "description": "Local script file path to inject before capture.", "nullable": true }, "style_url": { "type": "string", "maxLength": 2048, "title": "Style Url", "description": "Remote stylesheet URL to inject before capture.", "nullable": true }, "style_file": { "type": "string", "maxLength": 4096, "title": "Style File", "description": "Local stylesheet file path to inject before capture.", "nullable": true }, "auth_type": { "$ref": "#/components/schemas/AuthType", "description": "Auth to use when fetching `url` (none/basic/bearer).", "default": "none" }, "auth_credentials": { "type": "string", "maxLength": 2048, "title": "Auth Credentials", "description": "Credentials string for selected auth type (e.g. 'username:password' for basic).", "nullable": true }, "extra_headers": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Extra Headers", "description": "Extra headers to include when fetching `url`.", "nullable": true }, "cookies": { "items": { "additionalProperties": { "type": "string" }, "type": "object" }, "type": "array", "title": "Cookies", "description": "Cookies to seed in the browser context before capture.", "nullable": true }, "image_format": { "type": "string", "maxLength": 10, "minLength": 2, "title": "Image Format", "description": "Image output format: 'png' or 'jpeg'.", "default": "png" }, "response_mode": { "$ref": "#/components/schemas/ResponseMode", "description": "How to return the screenshot: binary/base64/json/url.", "default": "binary" }, "filename": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Filename", "description": "Suggested filename for downloads/storage.", "default": "screenshot.png" } }, "type": "object", "title": "ScreenshotRequest", "description": "Request model for screenshot endpoints.\n\nSupports `html` or `url` input, viewport sizing, output format and response\nmode control." }, "TemplateCreate": { "properties": { "name": { "type": "string", "title": "Name" }, "html": { "type": "string", "title": "Html" } }, "type": "object", "required": [ "name", "html" ], "title": "TemplateCreate", "description": "TemplateCreate\n\nSchema for creating a user template.\n\nProperties:\n- name: unique template name for the user.\n- html: the Jinja2 HTML source for the template." }, "TemplatePreviewRequest": { "properties": { "template_id": { "type": "string", "title": "Template Id" }, "data": { "additionalProperties": true, "type": "object", "title": "Data" } }, "type": "object", "required": [ "template_id" ], "title": "TemplatePreviewRequest" }, "TemplateRenderRequest": { "properties": { "template_id": { "type": "string", "maxLength": 64, "minLength": 1, "title": "Template Id", "description": "ID of the stored template to render." }, "data": { "additionalProperties": true, "type": "object", "title": "Data", "description": "Variables to render into the template." }, "wait_until": { "$ref": "#/components/schemas/WaitUntil", "description": "When to consider navigation finished before capturing.", "default": "networkidle" }, "custom_css": { "type": "string", "maxLength": 200000, "title": "Custom Css", "description": "CSS to inject into the rendered HTML before PDF conversion.", "nullable": true }, "execute_javascript": { "type": "boolean", "title": "Execute Javascript", "description": "Allow JS execution during rendering.", "default": true }, "header_template": { "type": "string", "maxLength": 200000, "title": "Header Template", "description": "HTML for header printed on each PDF page.", "nullable": true }, "footer_template": { "type": "string", "maxLength": 200000, "title": "Footer Template", "description": "HTML for footer printed on each PDF page.", "nullable": true }, "page_format": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Page Format", "description": "Page format for the PDF (A4, Letter, etc.).", "default": "A4" }, "margin_top": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Top", "description": "Top margin for PDF pages.", "default": "1cm" }, "margin_bottom": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Bottom", "description": "Bottom margin.", "default": "1cm" }, "margin_left": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Left", "description": "Left margin.", "default": "1cm" }, "margin_right": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Margin Right", "description": "Right margin.", "default": "1cm" }, "timeout": { "type": "integer", "maximum": 180000.0, "minimum": 1000.0, "title": "Timeout", "description": "Navigation/render timeout in milliseconds.", "default": 30000 }, "print_background": { "type": "boolean", "title": "Print Background", "description": "Whether CSS backgrounds should be printed.", "default": true }, "landscape": { "type": "boolean", "title": "Landscape", "description": "Render in landscape orientation.", "default": false }, "scale": { "type": "number", "maximum": 2.0, "minimum": 0.1, "title": "Scale", "description": "Scale factor for rendering.", "default": 1.0 }, "media_type": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Media Type", "description": "CSS media type to emulate.", "default": "screen" }, "prefer_css_page_size": { "type": "boolean", "title": "Prefer Css Page Size", "description": "Honor CSS @page size when present.", "default": false }, "page_ranges": { "type": "string", "maxLength": 64, "title": "Page Ranges", "description": "Page ranges to include, e.g. '1-3,5'.", "nullable": true }, "sanitize_html": { "type": "boolean", "title": "Sanitize Html", "description": "Apply lightweight HTML sanitization before rendering.", "default": false }, "auto_page_numbers": { "type": "boolean", "title": "Auto Page Numbers", "description": "Enable automatic page numbers in the footer.", "default": false }, "page_number_template": { "type": "string", "maxLength": 128, "title": "Page Number Template", "description": "Page number template.", "default": "{{page}} / {{totalPages}}", "nullable": true }, "page_number_alignment": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Page Number Alignment", "description": "Page number alignment.", "default": "center", "nullable": true }, "page_number_color": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Page Number Color", "description": "Page number color.", "default": "#444444", "nullable": true }, "page_number_font_size": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Page Number Font Size", "description": "Page number font size.", "default": "10px", "nullable": true }, "width": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Width", "description": "Custom page width.", "nullable": true }, "height": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "number" } ], "title": "Height", "description": "Custom page height.", "nullable": true }, "page_size": { "type": "string", "maxLength": 32, "title": "Page Size", "description": "Explicit page size override.", "nullable": true }, "wait_for_selector": { "type": "string", "maxLength": 256, "title": "Wait For Selector", "description": "Selector to wait for before rendering.", "nullable": true }, "wait_for_timeout": { "type": "integer", "maximum": 300000.0, "minimum": 0.0, "title": "Wait For Timeout", "description": "Timeout for selector/function waits in milliseconds.", "nullable": true }, "wait_for_function": { "type": "string", "maxLength": 200000, "title": "Wait For Function", "description": "JavaScript condition to wait for before rendering.", "nullable": true }, "scripts": { "items": { "type": "string" }, "type": "array", "title": "Scripts", "description": "Inline scripts or remote script URLs to inject before rendering.", "nullable": true }, "script_url": { "type": "string", "maxLength": 2048, "title": "Script Url", "description": "Single remote script URL to inject.", "nullable": true }, "script_file": { "type": "string", "maxLength": 4096, "title": "Script File", "description": "Local script file path to inject.", "nullable": true }, "style_url": { "type": "string", "maxLength": 2048, "title": "Style Url", "description": "Remote stylesheet URL to inject.", "nullable": true }, "style_file": { "type": "string", "maxLength": 4096, "title": "Style File", "description": "Local stylesheet file path to inject.", "nullable": true }, "password": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Password", "description": "Optional password to encrypt the generated PDF.", "nullable": true }, "title": { "type": "string", "maxLength": 100, "title": "Title", "description": "PDF title metadata.", "nullable": true }, "author": { "type": "string", "maxLength": 100, "title": "Author", "description": "PDF author metadata.", "nullable": true }, "subject": { "type": "string", "maxLength": 100, "title": "Subject", "description": "PDF subject metadata.", "nullable": true }, "keywords": { "items": { "type": "string" }, "type": "array", "title": "Keywords", "description": "PDF keywords metadata.", "nullable": true }, "creator": { "type": "string", "maxLength": 100, "title": "Creator", "description": "PDF creator metadata.", "nullable": true }, "producer": { "type": "string", "maxLength": 100, "title": "Producer", "description": "PDF producer metadata.", "nullable": true }, "custom_metadata": { "additionalProperties": true, "type": "object", "title": "Custom Metadata", "description": "Additional PDF metadata key/value pairs.", "nullable": true }, "compress": { "type": "boolean", "title": "Compress", "description": "Whether to compress the generated PDF streams.", "default": false }, "compression_level": { "$ref": "#/components/schemas/CompressionLevel", "description": "Compression intensity.", "nullable": true }, "compress_quality": { "type": "integer", "maximum": 95.0, "minimum": 30.0, "title": "Compress Quality", "description": "Approximate image compression quality.", "nullable": true }, "watermark_text": { "type": "string", "maxLength": 1024, "title": "Watermark Text", "description": "Text watermark to render on every page.", "nullable": true }, "watermark_font_size": { "type": "integer", "maximum": 500.0, "minimum": 1.0, "title": "Watermark Font Size", "description": "Watermark font size.", "default": 40, "nullable": true }, "watermark_color": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Watermark Color", "description": "Watermark color.", "default": "#000000", "nullable": true }, "watermark_opacity": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Watermark Opacity", "description": "Watermark opacity.", "default": 0.15, "nullable": true }, "watermark_rotation": { "type": "integer", "maximum": 360.0, "minimum": 0.0, "title": "Watermark Rotation", "description": "Watermark rotation in degrees.", "default": 45, "nullable": true }, "watermark_position": { "type": "string", "maxLength": 32, "minLength": 1, "title": "Watermark Position", "description": "Watermark position.", "default": "center", "nullable": true }, "watermark_image_url": { "type": "string", "maxLength": 2048, "title": "Watermark Image Url", "description": "Public image URL for watermarking.", "nullable": true }, "watermark_image_scale": { "type": "number", "maximum": 10.0, "minimum": 0.1, "title": "Watermark Image Scale", "description": "Watermark image scale factor.", "default": 1.0, "nullable": true }, "watermark_image_rotation": { "type": "integer", "maximum": 360.0, "minimum": 0.0, "title": "Watermark Image Rotation", "description": "Watermark image rotation.", "default": 45, "nullable": true }, "watermark_image_opacity": { "type": "number", "maximum": 1.0, "minimum": 0.0, "title": "Watermark Image Opacity", "description": "Watermark image opacity.", "default": 0.15, "nullable": true }, "response_mode": { "$ref": "#/components/schemas/ResponseMode", "description": "How to return the generated PDF: binary/base64/json/url.", "default": "binary" }, "filename": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Filename", "description": "Suggested filename for the generated PDF.", "default": "document.pdf" } }, "additionalProperties": false, "type": "object", "required": [ "template_id" ], "title": "TemplateRenderRequest", "description": "Request to render a stored template to PDF.\n\nFields map closely to `PDFRequest` and will be translated server-side.", "example": { "template_id": "tpl_1ab2cd3ef456", "data": { "customer_name": "Acme Corp", "invoice_number": "INV-2026-1042", "amount_due": "$129.99" }, "response_mode": "json", "filename": "invoice-2026-1042.pdf", "print_background": true, "title": "Invoice INV-2026-1042", "custom_metadata": { "template": "invoice", "channel": "api" }, "watermark_text": "PAID", "watermark_position": "center" } }, "WaitUntil": { "type": "string", "enum": [ "load", "domcontentloaded", "networkidle", "networkidle0", "networkidle2" ], "title": "WaitUntil", "description": "When to consider navigation/rendering finished.\n\nValues:\n- load: full load event fired\n- domcontentloaded: DOMContentLoaded event fired\n- networkidle: legacy alias for networkidle2\n- networkidle0: no network connections for at least 500 ms\n- networkidle2: at most 2 network connections for at least 500 ms" } }, "securitySchemes": { "APIKeyHeader": { "type": "apiKey", "in": "header", "name": "Authorization" }, "RapidAPIKey": { "type": "apiKey", "in": "header", "name": "X-RapidAPI-Key", "description": "For RapidAPI subscribers only. In production, requests must arrive through the RapidAPI gateway and are trusted only when the gateway proxy secret is validated by the backend." }, "InternalAPIKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key", "description": "For direct SarvaPDF customers only. Do not send this header from RapidAPI clients." }, "AuthToken": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Optional Bearer token path for internal tools and first-party integrations. RapidAPI consumers should use RapidAPI-managed auth." } }, "responses": { "Error": { "description": "Standard error response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }