Rendered by SnapAPI
", "format": "png", "width": 800, "height": 600 } } } } } }, "responses": { "200": { "description": "Screenshot captured successfully", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" }, "X-RateLimit-Limit": { "$ref": "#/components/headers/X-RateLimit-Limit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/X-RateLimit-Remaining" }, "X-RateLimit-Reset": { "$ref": "#/components/headers/X-RateLimit-Reset" } }, "content": { "image/png": { "schema": { "type": "string", "format": "binary" } }, "image/jpeg": { "schema": { "type": "string", "format": "binary" } }, "image/webp": { "schema": { "type": "string", "format": "binary" } }, "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotJsonResponse" } } } }, "202": { "description": "Async job accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AsyncJobResponse" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or missing API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Feature not available on your plan", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "takeScreenshotGet", "summary": "Take Screenshot (GET)", "description": "Simple GET endpoint for screenshots via query parameters.", "tags": [ "Screenshot" ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri" } }, { "name": "format", "in": "query", "schema": { "type": "string", "enum": [ "png", "jpeg", "webp", "avif", "pdf" ], "default": "png" } }, { "name": "quality", "in": "query", "schema": { "type": "integer" } }, { "name": "width", "in": "query", "schema": { "type": "integer", "default": 1280 } }, { "name": "height", "in": "query", "schema": { "type": "integer", "default": 800 } }, { "name": "full_page", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "dark_mode", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "block_ads", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "block_cookie_banners", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "cache", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "response_type", "in": "query", "schema": { "type": "string", "enum": [ "binary", "base64", "json" ], "default": "binary" } } ], "responses": { "200": { "description": "Screenshot captured" }, "400": { "description": "Validation error" }, "401": { "description": "Invalid API key" } } } }, "/v1/pdf": { "post": { "operationId": "generatePdf", "summary": "Generate PDF", "description": "Generate a PDF from any URL or HTML. Supports page sizes, margins, headers/footers, and scaling.", "tags": [ "PDF" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScreenshotRequest" }, "example": { "url": "https://example.com", "pdfOptions": { "pageSize": "a4", "landscape": false, "printBackground": true } } } } }, "responses": { "200": { "description": "PDF generated", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "Validation error" }, "401": { "description": "Invalid API key" } } } }, "/v1/screenshot/batch": { "post": { "operationId": "batchScreenshots", "summary": "Batch Screenshots", "description": "Submit up to 100 URLs for batch processing. Returns a job ID to poll for results.", "tags": [ "Screenshot" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchRequest" }, "example": { "urls": [ "https://example.com", "https://google.com" ], "format": "png", "width": 1280 } } } }, "responses": { "202": { "description": "Batch job accepted", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "jobId": { "type": "string" }, "status": { "type": "string" }, "total": { "type": "integer" }, "message": { "type": "string" } } } } } }, "429": { "description": "Quota exceeded" } } } }, "/v1/screenshot/batch/{jobId}": { "get": { "operationId": "getBatchStatus", "summary": "Get Batch Job Status", "tags": [ "Screenshot" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Batch job status with results" }, "404": { "description": "Job not found or expired" } } } }, "/v1/screenshot/async/{jobId}": { "get": { "operationId": "getAsyncStatus", "summary": "Get Async Screenshot Status", "tags": [ "Screenshot" ], "parameters": [ { "name": "jobId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "includeData", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] }, "description": "Include base64 data in response" } ], "responses": { "200": { "description": "Async job status" }, "404": { "description": "Job not found or expired" } } } }, "/v1/video": { "post": { "operationId": "recordVideo", "summary": "Record Video", "description": "Record a video of a webpage with optional scrolling. Supports WebM, MP4, and GIF output. Costs 5 credits per recording.", "tags": [ "Video" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoRequest" }, "examples": { "basic": { "summary": "5-second recording", "value": { "url": "https://example.com", "duration": 5, "format": "mp4" } }, "scrolling": { "summary": "Scrolling video", "value": { "url": "https://example.com", "duration": 10, "scrolling": true, "scrollSpeed": 150, "format": "webm" } } } } } }, "responses": { "200": { "description": "Video recorded", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "video/webm": { "schema": { "type": "string", "format": "binary" } }, "video/mp4": { "schema": { "type": "string", "format": "binary" } }, "image/gif": { "schema": { "type": "string", "format": "binary" } }, "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "data": { "type": "string" }, "format": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "duration": { "type": "integer" }, "fileSize": { "type": "integer" }, "took": { "type": "integer" } } } } } }, "400": { "description": "Validation error" }, "429": { "description": "Quota exceeded" }, "503": { "description": "Server busy (max concurrent videos reached)" } } } }, "/v1/extract": { "post": { "operationId": "extractContent", "summary": "Extract Web Content", "description": "Extract content from any webpage as HTML, text, markdown, article, links, images, metadata, or structured data. Optimized for LLM consumption.", "tags": [ "Extract" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractRequest" }, "examples": { "markdown": { "summary": "Extract as markdown", "value": { "url": "https://example.com", "type": "markdown" } }, "article": { "summary": "Extract article (Readability)", "value": { "url": "https://blog.example.com/post", "type": "article" } }, "structured": { "summary": "Structured extraction", "value": { "url": "https://example.com", "type": "structured", "maxLength": 10000 } }, "links": { "summary": "Extract all links", "value": { "url": "https://example.com", "type": "links" } } } } } }, "responses": { "200": { "description": "Content extracted", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractResponse" } } } }, "400": { "description": "Validation error" }, "401": { "description": "Invalid API key" } } }, "get": { "operationId": "extractContentGet", "summary": "Extract Web Content (GET)", "tags": [ "Extract" ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri" } }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "html", "text", "markdown", "article", "links", "images", "metadata", "structured" ], "default": "markdown" } }, { "name": "selector", "in": "query", "schema": { "type": "string" } }, { "name": "max_length", "in": "query", "schema": { "type": "integer" } }, { "name": "clean", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "true" } }, { "name": "block_ads", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "block_cookies", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } } ], "responses": { "200": { "description": "Content extracted" }, "400": { "description": "Validation error" } } } }, "/v1/analyze": { "post": { "operationId": "analyzeWebpage", "summary": "AI-Powered Web Analysis", "description": "Analyze any webpage using your own LLM API key (BYOK). Supports OpenAI and Anthropic. Optionally get structured JSON output via jsonSchema. Perfect for competitive intelligence, compliance audits, and data extraction.", "tags": [ "Analyze" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzeRequest" }, "examples": { "basic": { "summary": "Basic analysis", "value": { "url": "https://example.com", "prompt": "Summarize the main content", "provider": "openai", "apiKey": "sk-..." } }, "structured": { "summary": "Structured output", "value": { "url": "https://example.com/pricing", "prompt": "Extract all pricing plans", "provider": "openai", "apiKey": "sk-...", "jsonSchema": { "type": "object", "properties": { "plans": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "price": { "type": "string" }, "features": { "type": "array", "items": { "type": "string" } } } } } }, "required": [ "plans" ], "additionalProperties": false } } } } } } }, "responses": { "200": { "description": "Analysis complete", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnalyzeResponse" } } } }, "400": { "description": "Validation error" }, "401": { "description": "Invalid SnapAPI key" }, "502": { "description": "LLM provider error" } } } }, "/v1/usage": { "get": { "operationId": "getUsage", "summary": "Get API Usage", "description": "Check your current API usage and remaining quota.", "tags": [ "Usage" ], "responses": { "200": { "description": "Usage data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageResponse" }, "example": { "used": 150, "limit": 1000, "remaining": 850, "resetAt": "2026-03-01T00:00:00.000Z" } } } }, "401": { "description": "Invalid API key" } } } }, "/v1/devices": { "get": { "operationId": "listDevices", "summary": "List Device Presets", "description": "Get all available device presets (desktop, mobile, tablet) for screenshot emulation.", "tags": [ "Utilities" ], "security": [], "responses": { "200": { "description": "Device presets grouped by category" } } } }, "/v1/capabilities": { "get": { "operationId": "getCapabilities", "summary": "API Capabilities", "description": "Get supported formats, features, and limits.", "tags": [ "Utilities" ], "security": [], "responses": { "200": { "description": "API capabilities" } } } }, "/v1/scrape": { "post": { "operationId": "scrapeWebpage", "summary": "Scrape Webpage", "description": "Scrape content from any URL. Returns text, HTML, markdown, links, or metadata. Supports pagination for multi-page crawls, custom proxies, and resource blocking.", "tags": [ "Scrape" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScrapeRequest" }, "examples": { "text": { "summary": "Scrape as plain text", "value": { "url": "https://example.com", "type": "text" } }, "markdown": { "summary": "Scrape as markdown (LLM-ready)", "value": { "url": "https://example.com", "type": "markdown" } }, "links": { "summary": "Extract all links", "value": { "url": "https://example.com", "type": "links" } }, "metadata": { "summary": "Extract page metadata", "value": { "url": "https://example.com", "type": "metadata" } }, "multipage": { "summary": "3-page scrape", "value": { "url": "https://example.com/blog", "type": "text", "pages": 3, "waitMs": 500 } } } } } }, "responses": { "200": { "description": "Content scraped successfully", "headers": { "X-Request-Id": { "$ref": "#/components/headers/X-Request-Id" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScrapeResponse" } } } }, "400": { "description": "Validation error or invalid URL", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid or missing API key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limit or quota exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Scrape failed (site unreachable or timeout)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "operationId": "scrapeWebpageGet", "summary": "Scrape Webpage (GET)", "description": "Simple GET version of the scrape endpoint using query parameters.", "tags": [ "Scrape" ], "parameters": [ { "name": "url", "in": "query", "required": true, "schema": { "type": "string", "format": "uri" }, "description": "URL to scrape" }, { "name": "type", "in": "query", "schema": { "type": "string", "enum": [ "text", "html", "links" ], "default": "text" } }, { "name": "pages", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "wait_ms", "in": "query", "schema": { "type": "integer", "default": 0 } }, { "name": "block_resources", "in": "query", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "locale", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Content scraped", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScrapeResponse" } } } }, "400": { "description": "Validation error" }, "401": { "description": "Invalid API key" } } } }, "/auth/register": { "post": { "operationId": "register", "summary": "Register", "description": "Create a new account with email and password. A verification email is sent automatically. Rate limited to 3 requests/minute per IP.", "tags": [ "Auth" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string", "minLength": 8, "description": "Minimum 8 characters" }, "name": { "type": "string", "maxLength": 100, "description": "Optional display name" } } }, "example": { "email": "user@example.com", "password": "securepass123", "name": "Jane Developer" } } } }, "responses": { "200": { "description": "Registration successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "400": { "description": "Email already registered or invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited (3/min per IP)" } } } }, "/auth/login": { "post": { "operationId": "login", "summary": "Login", "description": "Authenticate with email and password. Returns a JWT access token and sets a HttpOnly refresh token cookie. Rate limited to 5 requests/minute per IP.", "tags": [ "Auth" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "password" ], "properties": { "email": { "type": "string", "format": "email" }, "password": { "type": "string" } } }, "example": { "email": "user@example.com", "password": "securepass123" } } } }, "responses": { "200": { "description": "Login successful. `refresh_token` set as HttpOnly cookie.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "401": { "description": "Invalid credentials", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Account disabled" }, "429": { "description": "Rate limited (5/min per IP)" } } } }, "/auth/google": { "post": { "operationId": "googleAuth", "summary": "Google OAuth", "description": "Sign in or register using a Google ID token obtained from Google Sign-In.", "tags": [ "Auth" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "credential" ], "properties": { "credential": { "type": "string", "description": "Google ID token from Google Sign-In" } } } } } }, "responses": { "200": { "description": "Authentication successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "400": { "description": "Invalid Google token" }, "501": { "description": "Google OAuth not configured" } } } }, "/auth/github": { "post": { "operationId": "githubAuth", "summary": "GitHub OAuth", "description": "Sign in or register using a GitHub OAuth authorization code.", "tags": [ "Auth" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "description": "GitHub OAuth authorization code" } } } } } }, "responses": { "200": { "description": "Authentication successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "400": { "description": "Invalid or expired authorization code" }, "501": { "description": "GitHub OAuth not configured" } } } }, "/auth/apple": { "post": { "operationId": "appleAuth", "summary": "Apple Sign-In", "description": "Sign in or register using an Apple ID token.", "tags": [ "Auth" ], "security": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "idToken" ], "properties": { "idToken": { "type": "string", "description": "Apple ID token" }, "user": { "type": "object", "description": "User info (only sent on first sign-in)", "properties": { "email": { "type": "string", "format": "email" }, "name": { "type": "object", "properties": { "firstName": { "type": "string" }, "lastName": { "type": "string" } } } } } } } } } }, "responses": { "200": { "description": "Authentication successful", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "400": { "description": "Invalid Apple token" } } } }, "/auth/refresh": { "post": { "operationId": "refreshToken", "summary": "Refresh Token", "description": "Exchange the `refresh_token` HttpOnly cookie for a new access token. Rotates the refresh token on each use.", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "New access token issued", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthResponse" } } } }, "401": { "description": "No refresh token cookie or token expired/invalid" } } } }, "/auth/logout": { "post": { "operationId": "logout", "summary": "Logout", "description": "Invalidate the current session and clear the refresh token cookie.", "tags": [ "Auth" ], "security": [], "responses": { "200": { "description": "Logged out successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } } } } }, "/auth/me": { "get": { "operationId": "getCurrentUser", "summary": "Get Current User", "description": "Get the authenticated user's profile. Requires `Authorization: Bearer