{ "openapi": "3.1.0", "info": { "title": "microbrowser.org", "version": "1.0.0", "description": "A browser API for AI workflows. Render JavaScript, convert URLs to Markdown or article JSON, and capture screenshots through one HTTP request." }, "servers": [ { "url": "https://microbrowser.org" } ], "externalDocs": { "description": "API reference with request examples", "url": "https://microbrowser.org/docs" }, "paths": { "/render": { "get": { "operationId": "renderPageGet", "summary": "Run an isolated Chromium browser. Images/PDF are binary, text/Markdown/HTML are UTF-8, JSON contains article and upstream status.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "png" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "renderPagePost", "summary": "Run an isolated Chromium browser. Images/PDF are binary, text/Markdown/HTML are UTF-8, JSON contains article and upstream status.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "png" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "png" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/text": { "get": { "operationId": "textPageGet", "summary": "Render page as text. format parameter can override.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "text" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "textPagePost", "summary": "Render page as text. format parameter can override.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "text" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "text" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/markdown": { "get": { "operationId": "markdownPageGet", "summary": "Render page as markdown. format parameter can override.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "markdown" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "markdownPagePost", "summary": "Render page as markdown. format parameter can override.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "markdown" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "markdown" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/html": { "get": { "operationId": "htmlPageGet", "summary": "Render page as html. format parameter can override.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "html" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "htmlPagePost", "summary": "Render page as html. format parameter can override.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "html" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "html" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/json": { "get": { "operationId": "jsonPageGet", "summary": "Render page as json. format parameter can override.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "json" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "jsonPagePost", "summary": "Render page as json. format parameter can override.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "json" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "json" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/pdf": { "get": { "operationId": "pdfPageGet", "summary": "Render page as pdf. format parameter can override.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "pdf" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "pdfPagePost", "summary": "Render page as pdf. format parameter can override.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "pdf" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "pdf" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/screenshot": { "get": { "operationId": "screenshotPageGet", "summary": "Render page as screenshot. format parameter can override.", "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "png" } }, { "name": "width", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 } }, { "name": "height", "in": "query", "required": false, "schema": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 } }, { "name": "scale", "in": "query", "required": false, "schema": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 } }, { "name": "full_page", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } }, { "name": "quality", "in": "query", "required": false, "schema": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 } }, { "name": "wait", "in": "query", "required": false, "schema": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 } }, { "name": "timeout", "in": "query", "required": false, "schema": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 } }, { "name": "selector", "in": "query", "required": false, "schema": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 } }, { "name": "javascript", "in": "query", "required": false, "schema": { "type": "boolean", "default": true } }, { "name": "mobile", "in": "query", "required": false, "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } }, "post": { "operationId": "screenshotPagePost", "summary": "Render page as screenshot. format parameter can override.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "png" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTP(S) destination.", "format": "uri", "example": "https://example.com" }, "format": { "type": "string", "description": "Output format.", "enum": [ "png", "jpeg", "webp", "text", "markdown", "html", "json", "pdf" ], "default": "png" }, "width": { "type": "integer", "description": "Viewport width.", "minimum": 240, "maximum": 2560, "default": 1280 }, "height": { "type": "integer", "description": "Viewport height.", "minimum": 200, "maximum": 2560, "default": 800 }, "scale": { "type": "number", "minimum": 1, "maximum": 2, "default": 1 }, "full_page": { "type": "boolean", "default": false }, "quality": { "type": "integer", "description": "JPEG/WebP quality.", "minimum": 1, "maximum": 100, "default": 80 }, "wait": { "type": "integer", "description": "Additional wait after DOM ready, milliseconds.", "minimum": 0, "maximum": 2000, "default": 0 }, "timeout": { "type": "integer", "description": "Per-operation timeout, milliseconds. Total render deadline 25 seconds after launch.", "minimum": 1000, "maximum": 20000, "default": 15000 }, "selector": { "type": "string", "description": "CSS selector to wait for and capture/extract.", "maxLength": 500 }, "javascript": { "type": "boolean", "default": true }, "mobile": { "type": "boolean", "default": false } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "default": { "$ref": "#/components/responses/Error" } } } }, "/docs": { "get": { "operationId": "documentation", "summary": "Server-rendered HTML API reference.", "responses": { "200": { "description": "Success", "content": { "text/html": { "schema": { "type": "string" } } } } } } }, "/robots.txt": { "get": { "operationId": "robots", "summary": "Crawler access rules and sitemap location.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } } } } }, "/sitemap.xml": { "get": { "operationId": "sitemap", "summary": "Public documentation sitemap.", "responses": { "200": { "description": "Success", "content": { "application/xml": { "schema": { "type": "string" } } } } } } }, "/health": { "get": { "operationId": "health", "summary": "Worker liveness (does not probe external dependencies).", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } } } } }, "/llms.txt": { "get": { "operationId": "agentGuide", "summary": "Plain-text agent usage guide.", "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "type": "string" } } } } } } } }, "components": { "responses": { "Error": { "description": "The request failed. See error.code and error.message for details.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "integer" }, "message": { "type": "string" } } } } } } } }