{ "openapi": "3.0.3", "info": { "title": "AGNT Scrape API", "version": "2026-09-24-scrape-v1", "description": "Turn any public URL, or an uploaded file, into markdown, html, text, links, code, a screenshot or the original bytes, from one visit. Web pages are rendered in a real browser; files with any of 76 extensions (PDF, Word, Excel, PowerPoint, CSV, JSON, RSS, source code and more) are converted. $0.004 per page pay as you go; monthly plans from $5. Blocked and failed pages are never charged. Page content is returned once and never stored. Prepaid funding with explicit spending caps; idempotent retries return receipts without a second visit. Minimum top-up $10." }, "servers": [ { "url": "https://scrape.agnt.gg" } ], "security": [ { "ApiKey": [] }, { "Session": [] } ], "paths": { "/scrape/v1/plans": { "get": { "operationId": "get__scrape_v1_plans", "summary": "Public pricing and plans", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "version": { "type": "string" }, "unit": { "type": "string" }, "ratesMicroUSD": { "type": "object" }, "tiers": { "type": "object" }, "formats": { "type": "array", "items": { "type": "string" } }, "limits": { "type": "object" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/capabilities": { "get": { "operationId": "get__scrape_v1_capabilities", "summary": "Service capabilities", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "service": { "type": "string" }, "signup": { "type": "boolean" }, "scrape": { "type": "boolean" }, "checkout": { "type": "boolean" }, "autonomousFunding": { "type": "boolean" }, "privacy": { "type": "object" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/health": { "get": { "operationId": "get__scrape_v1_health", "summary": "Liveness", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "service": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/readiness": { "get": { "operationId": "get__scrape_v1_readiness", "summary": "Readiness", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scrape": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/agents": { "post": { "operationId": "post__scrape_v1_agents", "summary": "Create a headless agent", "description": "Creates an account with an execution key. The secret is shown once. allowPrepaid authorizes up to $10/month of prepaid usage after funding.", "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{1,39}$" }, "allowPrepaid": { "type": "boolean" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "accountId": { "type": "string" }, "secret": { "type": "string" }, "keyId": { "type": "string" }, "fund": { "type": "object", "properties": { "claimUrl": { "type": "string" }, "x402": { "type": "string" } } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/agents/{id}/claim": { "get": { "operationId": "get__scrape_v1_agents__id__claim", "summary": "Look up an agent funding link", "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "agentId": { "type": "string" }, "name": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/agents/{id}/fund": { "post": { "operationId": "post__scrape_v1_agents__id__fund", "summary": "Fund an agent with prepaid credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "amountCents" ], "properties": { "amountCents": { "type": "integer", "enum": [ 1000, 2500, 5000 ] } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "orderId": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/scrape": { "post": { "operationId": "post__scrape_v1_scrape", "summary": "Scrape one page or file into markdown, html, text, links, code, a screenshot or the original bytes", "description": "Every requested format comes from ONE visit and costs one page. Web pages are rendered in a real browser inside an isolated, single-use VM. A URL that serves a file (PDF, Word, Excel, PowerPoint, CSV, JSON, RSS, source code and more) is converted instead, with a document object describing it. Pages that refuse automated access return 422 page_blocked, pages that do not exist return 404 page_not_found, and neither is ever charged. Included pages are used first, then prepaid credit up to maxChargeMicroUSD. Reuse the Idempotency-Key on an uncertain retry to receive the receipt instead of a second visit. Content is returned once and never stored. Required scope: scrape:execute", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "description": "Public http(s) URL. A bare domain is accepted and https is assumed." }, "formats": { "type": "object", "properties": { "markdown": { "type": "boolean", "default": true }, "html": { "type": "boolean", "default": false }, "text": { "type": "boolean", "default": false }, "links": { "type": "boolean", "default": false }, "code": { "type": "boolean", "default": false }, "screenshot": { "type": "boolean", "default": false }, "bytes": { "type": "boolean", "default": false } }, "description": "Outputs to return, all from one visit. Omitted means markdown only. At least one must be true. When the URL is a file (PDF, Word, Excel, PowerPoint, CSV, JSON...), it is converted instead of rendered; screenshot is then unavailable." }, "pageRange": { "type": "string", "pattern": "^\\d{1,4}(-\\d{1,4})?$", "description": "For PDFs: one page (\"5\") or an inclusive range (\"2-9\"). Up to 500 pages per request." }, "mainContentOnly": { "type": "boolean", "default": true, "description": "Drop navigation, headers, footers, sidebars and ads before building markdown, html and text. Links and code always come from the whole page." }, "waitForMs": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0, "description": "Extra time to wait after the page settles, for content that loads late." }, "maxChargeMicroUSD": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum prepaid credit this page may spend. 0 means included pages only." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string" }, "finalUrl": { "type": "string", "description": "Where the page ended up after redirects." }, "statusCode": { "type": "integer" }, "title": { "type": "string" }, "formats": { "type": "object", "properties": { "markdown": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "html": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "text": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "links": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } }, "code": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "screenshot": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string", "description": "data:image/jpeg;base64 URL of the viewport." } } }, "bytes": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string", "description": "The original response body as a data URL, up to 4 MiB." } } } } }, "isPartial": { "type": "boolean", "description": "True when at least one requested format failed but another succeeded." }, "document": { "type": "object", "properties": { "type": { "type": "string", "description": "pdf, docx, xlsx, pptx, csv, tsv, json, yaml, feed, xml, svg, html, markdown, text, code, rtf or image." }, "contentType": { "type": "string" }, "bytes": { "type": "integer" }, "pages": { "type": "integer" }, "pagesConverted": { "type": "array", "items": { "type": "integer" } }, "sheets": { "type": "integer" }, "rows": { "type": "integer" }, "slides": { "type": "integer" }, "items": { "type": "integer" }, "language": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } } }, "requestId": { "type": "string" }, "usage": { "type": "object", "properties": { "operation": { "type": "string" }, "chargedMicroUSD": { "type": "integer" }, "includedUnits": { "type": "integer" }, "policyVersion": { "type": "string" } } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/parse": { "post": { "operationId": "post__scrape_v1_parse", "summary": "Convert an uploaded file into markdown, html, text, links and code", "description": "Send the file itself as the request body (no multipart, no JSON wrapper), up to 20 MiB. The file type comes from its signature, then its Content-Type, then the extension parameter. One file costs one page, billed exactly like a scrape. The same Idempotency-Key with the same file returns the receipt; with a different file it is a conflict. Scanned PDFs without a text layer return 422 pdf_images_only and are not charged. Required scope: scrape:execute", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } }, { "name": "extension", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "pdf", "docx", "xlsx", "xlsm", "pptx", "csv", "tsv", "json", "geojson", "yaml", "yml", "xml", "rss", "atom", "svg", "html", "htm", "xhtml", "md", "markdown", "mdx", "txt", "text", "log", "rtf", "png", "jpg", "jpeg", "gif", "webp", "bmp", "js", "mjs", "cjs", "jsx", "ts", "tsx", "py", "rb", "go", "rs", "java", "kt", "c", "h", "cpp", "cc", "hpp", "cs", "php", "swift", "sh", "bash", "zsh", "ps1", "sql", "css", "scss", "less", "toml", "ini", "cfg", "conf", "lua", "r", "dart", "scala", "pl", "ex", "exs", "vue", "svelte", "graphql", "proto", "tf", "jsonl" ] }, "description": "The file extension, without the dot." }, { "name": "formats", "in": "query", "required": false, "schema": { "type": "string", "default": "markdown" }, "description": "Comma-separated: markdown, html, text, links, code." }, { "name": "pageRange", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^\\d{1,4}(-\\d{1,4})?$" }, "description": "For PDFs: \"5\" or \"2-9\"." }, { "name": "filename", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 200 }, "description": "Used as the title when the file has none." }, { "name": "mainContentOnly", "in": "query", "required": false, "schema": { "type": "boolean", "default": true }, "description": "For HTML uploads: drop navigation and page furniture." }, { "name": "maxChargeMicroUSD", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "default": 0 }, "description": "Maximum prepaid credit this file may spend. 0 means included pages only." } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "url": { "type": "string" }, "finalUrl": { "type": "string", "description": "Where the page ended up after redirects." }, "statusCode": { "type": "integer" }, "title": { "type": "string" }, "formats": { "type": "object", "properties": { "markdown": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "html": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "text": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "links": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "array", "items": { "type": "string" } } } }, "code": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string" } } }, "screenshot": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string", "description": "data:image/jpeg;base64 URL of the viewport." } } }, "bytes": { "type": "object", "properties": { "requested": { "type": "boolean" }, "success": { "type": "boolean" }, "data": { "type": "string", "description": "The original response body as a data URL, up to 4 MiB." } } } } }, "isPartial": { "type": "boolean", "description": "True when at least one requested format failed but another succeeded." }, "document": { "type": "object", "properties": { "type": { "type": "string", "description": "pdf, docx, xlsx, pptx, csv, tsv, json, yaml, feed, xml, svg, html, markdown, text, code, rtf or image." }, "contentType": { "type": "string" }, "bytes": { "type": "integer" }, "pages": { "type": "integer" }, "pagesConverted": { "type": "array", "items": { "type": "integer" } }, "sheets": { "type": "integer" }, "rows": { "type": "integer" }, "slides": { "type": "integer" }, "items": { "type": "integer" }, "language": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" } } }, "requestId": { "type": "string" }, "usage": { "type": "object", "properties": { "operation": { "type": "string" }, "chargedMicroUSD": { "type": "integer" }, "includedUnits": { "type": "integer" }, "policyVersion": { "type": "string" } } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } }, "*/*": { "schema": { "type": "string", "format": "binary" } } } } } }, "/scrape/v1/quote": { "post": { "operationId": "post__scrape_v1_quote", "summary": "Price a page before scraping it", "description": "Advisory only; reserves nothing. Required scope: scrape:read", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri", "description": "Public http(s) URL. A bare domain is accepted and https is assumed." }, "formats": { "type": "object", "properties": { "markdown": { "type": "boolean", "default": true }, "html": { "type": "boolean", "default": false }, "text": { "type": "boolean", "default": false }, "links": { "type": "boolean", "default": false }, "code": { "type": "boolean", "default": false }, "screenshot": { "type": "boolean", "default": false }, "bytes": { "type": "boolean", "default": false } }, "description": "Outputs to return, all from one visit. Omitted means markdown only. At least one must be true. When the URL is a file (PDF, Word, Excel, PowerPoint, CSV, JSON...), it is converted instead of rendered; screenshot is then unavailable." }, "pageRange": { "type": "string", "pattern": "^\\d{1,4}(-\\d{1,4})?$", "description": "For PDFs: one page (\"5\") or an inclusive range (\"2-9\"). Up to 500 pages per request." }, "mainContentOnly": { "type": "boolean", "default": true, "description": "Drop navigation, headers, footers, sidebars and ads before building markdown, html and text. Links and code always come from the whole page." }, "waitForMs": { "type": "integer", "minimum": 0, "maximum": 10000, "default": 0, "description": "Extra time to wait after the page settles, for content that loads late." }, "maxChargeMicroUSD": { "type": "integer", "minimum": 0, "default": 0, "description": "Maximum prepaid credit this page may spend. 0 means included pages only." } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "operation": { "type": "string" }, "maximumChargeMicroUSD": { "type": "integer" }, "included": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/usage": { "get": { "operationId": "get__scrape_v1_usage", "summary": "Plan, allowance and balance", "description": "Required scope: scrape:read", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountId": { "type": "string" }, "owner": { "type": "boolean" }, "source": { "type": "string", "enum": [ "standalone", "agnt_subscription", "payg" ] }, "tier": { "type": "string" }, "planName": { "type": "string" }, "includedPages": { "type": "integer" }, "usedPages": { "type": "integer" }, "remainingPages": { "type": "integer" }, "allowOverage": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "cashCapMicroUSD": { "type": "integer" }, "balance": { "type": "object" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/requests": { "get": { "operationId": "get__scrape_v1_requests", "summary": "Recent page receipts", "description": "Receipts record state, charges and errors. URLs and page content are not stored. Required scope: scrape:read", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "requests": { "type": "array", "items": { "$ref": "#/components/schemas/Receipt" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/requests/{id}": { "get": { "operationId": "get__scrape_v1_requests__id_", "summary": "One page receipt", "description": "Required scope: scrape:read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Receipt" } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/keys": { "get": { "operationId": "get__scrape_v1_keys", "summary": "List API keys", "description": "Owner only.", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__scrape_v1_keys", "summary": "Create a scoped API key", "description": "Owner only. The secret is shown once. Keys last until revoked unless expiresAt is set.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "scopes" ], "properties": { "scopes": { "type": "array", "items": { "type": "string", "enum": [ "scrape:execute", "scrape:read", "scrape:fund" ] } }, "expiresAt": { "type": "integer", "nullable": true }, "cashCapMicroUSD": { "type": "integer" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "expiresAt": { "type": "integer", "nullable": true }, "cashCapMicroUSD": { "type": "integer" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/keys/{id}": { "delete": { "operationId": "delete__scrape_v1_keys__id_", "summary": "Revoke an API key", "description": "Owner only.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/hosting/preferences": { "put": { "operationId": "put__scrape_v1_hosting_preferences", "summary": "Set spending preferences", "description": "Owner only. Controls prepaid usage beyond included pages, plan renewal and the monthly cash cap.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "allowOverage", "autoRenew", "cashCapMicroUSD" ], "properties": { "allowOverage": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "cashCapMicroUSD": { "type": "integer" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "allowOverage": { "type": "boolean" }, "autoRenew": { "type": "boolean" }, "cashCapMicroUSD": { "type": "integer" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/hosting/purchase": { "post": { "operationId": "post__scrape_v1_hosting_purchase", "summary": "Activate a monthly plan from prepaid credit", "description": "Owner only. Optional and standalone; no AGNT subscription required. The plan price is debited from prepaid credit, so there is never an automatic card charge. Starter $5 includes 2,250 pages; Pro $15 includes 7,000 pages; Business $39 includes 18,000 pages. Buying a higher tier mid-month upgrades in place and charges only the difference.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "tier": { "type": "string", "enum": [ "starter", "pro", "business" ], "default": "starter" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "start_at": { "type": "integer" }, "end_at": { "type": "integer" }, "price": { "type": "integer" }, "upgraded": { "type": "boolean" }, "tier": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/funding/checkout": { "post": { "operationId": "post__scrape_v1_funding_checkout", "summary": "Add prepaid credit with Stripe Checkout", "description": "Owner only.", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "amountCents" ], "properties": { "amountCents": { "type": "integer", "enum": [ 1000, 2500, 5000 ] } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "orderId": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/funding/orders/{id}": { "get": { "operationId": "get__scrape_v1_funding_orders__id_", "summary": "Funding order state", "description": "Required scope: scrape:read", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "amount_cents": { "type": "integer" }, "state": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/funding/x402": { "post": { "operationId": "post__scrape_v1_funding_x402", "summary": "Create an x402 funding order", "description": "Returns HTTP 402 with a base64 PAYMENT-REQUIRED header. x402 v2, USDC on Base. Scope: scrape:fund", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 8, "maxLength": 128 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "amountCents" ], "properties": { "amountCents": { "type": "integer", "enum": [ 1000, 2500, 5000 ] } } } } } }, "responses": { "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderId": { "type": "string" }, "requirements": { "type": "object" } } } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/funding/x402/{id}": { "get": { "operationId": "get__scrape_v1_funding_x402__id_", "summary": "x402 order state", "description": "Required scope: scrape:fund", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderId": { "type": "string" }, "state": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__scrape_v1_funding_x402__id_", "summary": "Submit an x402 payment signature", "description": "Send PAYMENT-SIGNATURE. Never pay a second order to recover a timeout; poll this one. Scope: scrape:fund", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "PAYMENT-SIGNATURE", "in": "header", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "orderId": { "type": "string" }, "state": { "type": "string" }, "settlement": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/webhooks": { "get": { "operationId": "get__scrape_v1_webhooks", "summary": "List notification receivers", "description": "Owner only.", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "receivers": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "operationId": "post__scrape_v1_webhooks", "summary": "Register a notification receiver", "description": "Owner only. Up to three HTTPS receivers. The signing secret is shown once.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" } } } } } }, "responses": { "201": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "secret": { "type": "string" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/webhooks/{id}": { "delete": { "operationId": "delete__scrape_v1_webhooks__id_", "summary": "Revoke a notification receiver", "description": "Owner only.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "revoked": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/notifications": { "get": { "operationId": "get__scrape_v1_notifications", "summary": "Notification events and delivery attempts", "description": "Required scope: scrape:read", "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object" } }, "attempts": { "type": "array", "items": { "type": "object" } } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/notifications/replay": { "post": { "operationId": "post__scrape_v1_notifications_replay", "summary": "Replay a notification", "description": "Owner only.", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "eventId" ], "properties": { "eventId": { "type": "string" }, "receiverId": { "type": "string" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "replayed": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/auth/request": { "post": { "operationId": "post__scrape_auth_request", "summary": "Request an email verification code", "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email" ], "properties": { "email": { "type": "string", "format": "email" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/auth/verify": { "post": { "operationId": "post__scrape_auth_verify", "summary": "Verify a code and start a session", "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "email", "code" ], "properties": { "email": { "type": "string", "format": "email" }, "code": { "type": "string", "pattern": "^[0-9]{6}$" } } } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/auth/logout": { "post": { "operationId": "post__scrape_auth_logout", "summary": "End the session", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/scrape/v1/payments/webhook": { "post": { "operationId": "post__scrape_v1_payments_webhook", "summary": "Stripe webhook", "description": "Signed by Stripe. Not for direct use.", "security": [], "parameters": [], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "received": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "402": { "description": "Payment or spending authorization required", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden, or the destination is not a public address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict or in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "413": { "description": "The file or result is larger than the limit (result_too_large). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "415": { "description": "The file type is not one Scrape converts (unsupported_file_type). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "The site refused automated access (page_blocked), the content had no readable text (extraction_failed), or a PDF has no text layer (pdf_images_only). Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Capacity or rate limit", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Temporarily unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "The page did not finish loading in time. Never charged.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "ApiKey": { "type": "http", "scheme": "bearer", "description": "An agent secret or key (scrp_...), or an AGNT session token." }, "Session": { "type": "apiKey", "in": "cookie", "name": "scrape_session" } }, "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "success": { "type": "boolean" }, "error": { "type": "string" } } }, "Usage": { "type": "object", "properties": { "operation": { "type": "string" }, "chargedMicroUSD": { "type": "integer" }, "includedUnits": { "type": "integer" }, "policyVersion": { "type": "string" } } }, "Receipt": { "type": "object", "properties": { "id": { "type": "string" }, "operation": { "type": "string" }, "state": { "type": "string", "enum": [ "running", "completed", "failed" ] }, "charge": { "type": "integer" }, "included": { "type": "integer" }, "runtime_ms": { "type": "integer" }, "policy": { "type": "string" }, "error": { "type": "string" }, "created_at": { "type": "integer" }, "completed_at": { "type": "integer" } } } } } }