{ "item": [ { "name": "Scrape", "description": "Render any URL with JS, return HTML / PDF / screenshot.", "item": [ { "id": "ab4a2d35-16ee-4635-b4f8-e38219e4318c", "name": "Render and scrape a URL", "request": { "name": "Render and scrape a URL", "description": { "content": "Render any URL through a headless Chrome browser and return final HTML (or PDF / screenshot via `response_type`). Supports JS execution, CSS extraction rules, proxies (rotating, premium, residential, mobile, custom), automatic CAPTCHA solving, and scroll behaviour. Failed fetches are not billed.", "type": "text/plain" }, "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to render.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "What to return. One of: html, raw, pdf, screenshot. (This can only be one of html,raw,pdf,screenshot)", "type": "text/plain" }, "key": "response_type", "value": "html" }, { "disabled": false, "description": { "content": "Wrap the response as JSON instead of raw content.", "type": "text/plain" }, "key": "json", "value": "false" }, { "disabled": false, "description": { "content": "Execute JavaScript on the page.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Seconds to wait for the browser to load the page when js=true.", "type": "text/plain" }, "key": "js_timeout", "value": "30" }, { "disabled": false, "description": { "content": "Base64-encoded JavaScript to execute in the page context (when js=true).", "type": "text/plain" }, "key": "custom_js", "value": "" }, { "disabled": false, "description": { "content": "ms to wait, a CSS selector to wait for, or a JS expression. Requires js=true.", "type": "text/plain" }, "key": "wait_for", "value": "0" }, { "disabled": false, "description": { "content": "Timeout (seconds) for wait_for. Falls back to timeout if 0.", "type": "text/plain" }, "key": "wait_for_timeout", "value": "0" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Override the default headless browser user agent.", "type": "text/plain" }, "key": "useragent", "value": "" }, { "disabled": false, "description": { "content": "Cookies to send with the request (header string or JSON object).", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Device profile to render as. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Browser viewport width in px.", "type": "text/plain" }, "key": "window_width", "value": "" }, { "disabled": false, "description": { "content": "Browser viewport height in px.", "type": "text/plain" }, "key": "window_height", "value": "" }, { "disabled": false, "description": { "content": "When response_type=screenshot, capture the full page (vs. viewport).", "type": "text/plain" }, "key": "screenshot_fullpage", "value": "true" }, { "disabled": false, "description": { "content": "CSS selector or JSON `{x,y,width,height}` to capture a region when response_type=screenshot.", "type": "text/plain" }, "key": "screenshot_partial", "value": "" }, { "disabled": false, "description": { "content": "Scroll down the page (requires js=true).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scrolls when scroll_down=true.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Progressive scroll until page height stops growing.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "Base64-encoded JS callback returning boolean to control stop.", "type": "text/plain" }, "key": "scroll_callback", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to scroll to on each scroll step.", "type": "text/plain" }, "key": "scroll_to_selector", "value": "" }, { "disabled": false, "description": { "content": "Proxy type. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (premium / residential only).", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure. Billed only on the top tier attempted.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Alphanumeric (1-16) identifier \u2014 sticky proxy for 30 min.", "type": "text/plain" }, "key": "proxy_session", "value": "" }, { "disabled": false, "description": { "content": "scheme://host:port \u2014 required when proxy_type=custom.", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy username, if needed.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy password, if needed.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Block ad resources.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Block images/css/fonts. Defaults to false for screenshot/pdf.", "type": "text/plain" }, "key": "block_resources", "value": "true" }, { "disabled": false, "description": { "content": "JSON object defining extraction rules.", "type": "text/plain" }, "key": "extract_rules", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated tag names/selectors to strip from result.", "type": "text/plain" }, "key": "strip_tags", "value": "" }, { "disabled": false, "description": { "content": "HTTP method used to request the target URL. (This can only be one of GET,POST,PUT)", "type": "text/plain" }, "key": "http_method", "value": "GET" }, { "disabled": false, "description": { "content": "Body to forward to target URL when http_method=POST/PUT.", "type": "text/plain" }, "key": "post_data", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve reCAPTCHA v2/v3, hCaptcha, Turnstile, FunCaptcha, GeeTest, and image CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Seconds before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a106d6a9-ac79-485a-89de-96d0a0514653", "name": "Rendered HTML (or PDF / screenshot / JSON wrapper depending on response_type).", "originalRequest": { "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to render.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "What to return. One of: html, raw, pdf, screenshot. (This can only be one of html,raw,pdf,screenshot)", "type": "text/plain" }, "key": "response_type", "value": "html" }, { "disabled": false, "description": { "content": "Wrap the response as JSON instead of raw content.", "type": "text/plain" }, "key": "json", "value": "false" }, { "disabled": false, "description": { "content": "Execute JavaScript on the page.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Seconds to wait for the browser to load the page when js=true.", "type": "text/plain" }, "key": "js_timeout", "value": "30" }, { "disabled": false, "description": { "content": "Base64-encoded JavaScript to execute in the page context (when js=true).", "type": "text/plain" }, "key": "custom_js", "value": "" }, { "disabled": false, "description": { "content": "ms to wait, a CSS selector to wait for, or a JS expression. Requires js=true.", "type": "text/plain" }, "key": "wait_for", "value": "0" }, { "disabled": false, "description": { "content": "Timeout (seconds) for wait_for. Falls back to timeout if 0.", "type": "text/plain" }, "key": "wait_for_timeout", "value": "0" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Override the default headless browser user agent.", "type": "text/plain" }, "key": "useragent", "value": "" }, { "disabled": false, "description": { "content": "Cookies to send with the request (header string or JSON object).", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Device profile to render as. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Browser viewport width in px.", "type": "text/plain" }, "key": "window_width", "value": "" }, { "disabled": false, "description": { "content": "Browser viewport height in px.", "type": "text/plain" }, "key": "window_height", "value": "" }, { "disabled": false, "description": { "content": "When response_type=screenshot, capture the full page (vs. viewport).", "type": "text/plain" }, "key": "screenshot_fullpage", "value": "true" }, { "disabled": false, "description": { "content": "CSS selector or JSON `{x,y,width,height}` to capture a region when response_type=screenshot.", "type": "text/plain" }, "key": "screenshot_partial", "value": "" }, { "disabled": false, "description": { "content": "Scroll down the page (requires js=true).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scrolls when scroll_down=true.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Progressive scroll until page height stops growing.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "Base64-encoded JS callback returning boolean to control stop.", "type": "text/plain" }, "key": "scroll_callback", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to scroll to on each scroll step.", "type": "text/plain" }, "key": "scroll_to_selector", "value": "" }, { "disabled": false, "description": { "content": "Proxy type. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (premium / residential only).", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure. Billed only on the top tier attempted.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Alphanumeric (1-16) identifier \u2014 sticky proxy for 30 min.", "type": "text/plain" }, "key": "proxy_session", "value": "" }, { "disabled": false, "description": { "content": "scheme://host:port \u2014 required when proxy_type=custom.", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy username, if needed.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy password, if needed.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Block ad resources.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Block images/css/fonts. Defaults to false for screenshot/pdf.", "type": "text/plain" }, "key": "block_resources", "value": "true" }, { "disabled": false, "description": { "content": "JSON object defining extraction rules.", "type": "text/plain" }, "key": "extract_rules", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated tag names/selectors to strip from result.", "type": "text/plain" }, "key": "strip_tags", "value": "" }, { "disabled": false, "description": { "content": "HTTP method used to request the target URL. (This can only be one of GET,POST,PUT)", "type": "text/plain" }, "key": "http_method", "value": "GET" }, { "disabled": false, "description": { "content": "Body to forward to target URL when http_method=POST/PUT.", "type": "text/plain" }, "key": "post_data", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve reCAPTCHA v2/v3, hCaptcha, Turnstile, FunCaptcha, GeeTest, and image CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Seconds before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/html" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7087bd15-ca33-45d2-8f8f-a66e185c6b5f", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to render.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "What to return. One of: html, raw, pdf, screenshot. (This can only be one of html,raw,pdf,screenshot)", "type": "text/plain" }, "key": "response_type", "value": "html" }, { "disabled": false, "description": { "content": "Wrap the response as JSON instead of raw content.", "type": "text/plain" }, "key": "json", "value": "false" }, { "disabled": false, "description": { "content": "Execute JavaScript on the page.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Seconds to wait for the browser to load the page when js=true.", "type": "text/plain" }, "key": "js_timeout", "value": "30" }, { "disabled": false, "description": { "content": "Base64-encoded JavaScript to execute in the page context (when js=true).", "type": "text/plain" }, "key": "custom_js", "value": "" }, { "disabled": false, "description": { "content": "ms to wait, a CSS selector to wait for, or a JS expression. Requires js=true.", "type": "text/plain" }, "key": "wait_for", "value": "0" }, { "disabled": false, "description": { "content": "Timeout (seconds) for wait_for. Falls back to timeout if 0.", "type": "text/plain" }, "key": "wait_for_timeout", "value": "0" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Override the default headless browser user agent.", "type": "text/plain" }, "key": "useragent", "value": "" }, { "disabled": false, "description": { "content": "Cookies to send with the request (header string or JSON object).", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Device profile to render as. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Browser viewport width in px.", "type": "text/plain" }, "key": "window_width", "value": "" }, { "disabled": false, "description": { "content": "Browser viewport height in px.", "type": "text/plain" }, "key": "window_height", "value": "" }, { "disabled": false, "description": { "content": "When response_type=screenshot, capture the full page (vs. viewport).", "type": "text/plain" }, "key": "screenshot_fullpage", "value": "true" }, { "disabled": false, "description": { "content": "CSS selector or JSON `{x,y,width,height}` to capture a region when response_type=screenshot.", "type": "text/plain" }, "key": "screenshot_partial", "value": "" }, { "disabled": false, "description": { "content": "Scroll down the page (requires js=true).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scrolls when scroll_down=true.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Progressive scroll until page height stops growing.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "Base64-encoded JS callback returning boolean to control stop.", "type": "text/plain" }, "key": "scroll_callback", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to scroll to on each scroll step.", "type": "text/plain" }, "key": "scroll_to_selector", "value": "" }, { "disabled": false, "description": { "content": "Proxy type. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (premium / residential only).", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure. Billed only on the top tier attempted.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Alphanumeric (1-16) identifier \u2014 sticky proxy for 30 min.", "type": "text/plain" }, "key": "proxy_session", "value": "" }, { "disabled": false, "description": { "content": "scheme://host:port \u2014 required when proxy_type=custom.", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy username, if needed.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy password, if needed.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Block ad resources.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Block images/css/fonts. Defaults to false for screenshot/pdf.", "type": "text/plain" }, "key": "block_resources", "value": "true" }, { "disabled": false, "description": { "content": "JSON object defining extraction rules.", "type": "text/plain" }, "key": "extract_rules", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated tag names/selectors to strip from result.", "type": "text/plain" }, "key": "strip_tags", "value": "" }, { "disabled": false, "description": { "content": "HTTP method used to request the target URL. (This can only be one of GET,POST,PUT)", "type": "text/plain" }, "key": "http_method", "value": "GET" }, { "disabled": false, "description": { "content": "Body to forward to target URL when http_method=POST/PUT.", "type": "text/plain" }, "key": "post_data", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve reCAPTCHA v2/v3, hCaptcha, Turnstile, FunCaptcha, GeeTest, and image CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Seconds before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7d45b86e-be84-4dd2-b5ae-65f02600072e", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to render.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "What to return. One of: html, raw, pdf, screenshot. (This can only be one of html,raw,pdf,screenshot)", "type": "text/plain" }, "key": "response_type", "value": "html" }, { "disabled": false, "description": { "content": "Wrap the response as JSON instead of raw content.", "type": "text/plain" }, "key": "json", "value": "false" }, { "disabled": false, "description": { "content": "Execute JavaScript on the page.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Seconds to wait for the browser to load the page when js=true.", "type": "text/plain" }, "key": "js_timeout", "value": "30" }, { "disabled": false, "description": { "content": "Base64-encoded JavaScript to execute in the page context (when js=true).", "type": "text/plain" }, "key": "custom_js", "value": "" }, { "disabled": false, "description": { "content": "ms to wait, a CSS selector to wait for, or a JS expression. Requires js=true.", "type": "text/plain" }, "key": "wait_for", "value": "0" }, { "disabled": false, "description": { "content": "Timeout (seconds) for wait_for. Falls back to timeout if 0.", "type": "text/plain" }, "key": "wait_for_timeout", "value": "0" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Override the default headless browser user agent.", "type": "text/plain" }, "key": "useragent", "value": "" }, { "disabled": false, "description": { "content": "Cookies to send with the request (header string or JSON object).", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Device profile to render as. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Browser viewport width in px.", "type": "text/plain" }, "key": "window_width", "value": "" }, { "disabled": false, "description": { "content": "Browser viewport height in px.", "type": "text/plain" }, "key": "window_height", "value": "" }, { "disabled": false, "description": { "content": "When response_type=screenshot, capture the full page (vs. viewport).", "type": "text/plain" }, "key": "screenshot_fullpage", "value": "true" }, { "disabled": false, "description": { "content": "CSS selector or JSON `{x,y,width,height}` to capture a region when response_type=screenshot.", "type": "text/plain" }, "key": "screenshot_partial", "value": "" }, { "disabled": false, "description": { "content": "Scroll down the page (requires js=true).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scrolls when scroll_down=true.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Progressive scroll until page height stops growing.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "Base64-encoded JS callback returning boolean to control stop.", "type": "text/plain" }, "key": "scroll_callback", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to scroll to on each scroll step.", "type": "text/plain" }, "key": "scroll_to_selector", "value": "" }, { "disabled": false, "description": { "content": "Proxy type. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code (premium / residential only).", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure. Billed only on the top tier attempted.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Alphanumeric (1-16) identifier \u2014 sticky proxy for 30 min.", "type": "text/plain" }, "key": "proxy_session", "value": "" }, { "disabled": false, "description": { "content": "scheme://host:port \u2014 required when proxy_type=custom.", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy username, if needed.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Custom proxy password, if needed.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Block ad resources.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Block images/css/fonts. Defaults to false for screenshot/pdf.", "type": "text/plain" }, "key": "block_resources", "value": "true" }, { "disabled": false, "description": { "content": "JSON object defining extraction rules.", "type": "text/plain" }, "key": "extract_rules", "value": "" }, { "disabled": false, "description": { "content": "Comma-separated tag names/selectors to strip from result.", "type": "text/plain" }, "key": "strip_tags", "value": "" }, { "disabled": false, "description": { "content": "HTTP method used to request the target URL. (This can only be one of GET,POST,PUT)", "type": "text/plain" }, "key": "http_method", "value": "GET" }, { "disabled": false, "description": { "content": "Body to forward to target URL when http_method=POST/PUT.", "type": "text/plain" }, "key": "post_data", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve reCAPTCHA v2/v3, hCaptcha, Turnstile, FunCaptcha, GeeTest, and image CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Seconds before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "37ae43e6-a658-4e6e-97cc-3b14bf8fd940", "name": "Render and scrape (POST body)", "request": { "name": "Render and scrape (POST body)", "description": { "content": "Same as GET /scrape but with parameters in the JSON body. Required when extract_rules or custom_js exceed query-string length.", "type": "text/plain" }, "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/html" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"response_type\": \"html\",\n \"json\": false,\n \"js\": false,\n \"wait_for\": \"\",\n \"proxy_type\": \"rotating\",\n \"proxy_country\": \"US\",\n \"extract_rules\": {\n \"key_0\": true\n },\n \"auto_captcha_solve\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "773f8ac0-c263-4978-ab4b-f13cc2f3d0a9", "name": "Rendered HTML (or PDF / screenshot / JSON wrapper depending on response_type).", "originalRequest": { "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "text/html" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"response_type\": \"html\",\n \"json\": false,\n \"js\": false,\n \"wait_for\": \"\",\n \"proxy_type\": \"rotating\",\n \"proxy_country\": \"US\",\n \"extract_rules\": {\n \"key_0\": true\n },\n \"auto_captcha_solve\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15fc5774-5327-4b3b-adf5-10223cd33ce1", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"response_type\": \"html\",\n \"json\": false,\n \"js\": false,\n \"wait_for\": \"\",\n \"proxy_type\": \"rotating\",\n \"proxy_country\": \"US\",\n \"extract_rules\": {\n \"key_0\": true\n },\n \"auto_captcha_solve\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fb7130e1-c016-47dc-b67a-232b1565bc05", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "scrape" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"response_type\": \"html\",\n \"json\": false,\n \"js\": false,\n \"wait_for\": \"\",\n \"proxy_type\": \"rotating\",\n \"proxy_country\": \"US\",\n \"extract_rules\": {\n \"key_0\": true\n },\n \"auto_captcha_solve\": false\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Extract", "description": "Auto-detect article / product / listing and return clean structured data.", "item": [ { "id": "42a7ffc4-a5b4-4fd4-8b09-25424e4ed155", "name": "Article / page extraction", "request": { "name": "Article / page extraction", "description": { "content": "Extract the main text and metadata of an article: clean body HTML, plain text, author, publish date, media, RSS feeds, and images. Auto-detects whether a URL is an article via the `is_article` probability score.", "type": "text/plain" }, "url": { "path": [ "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the article.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Inline HTML to extract from. When set, the URL is only used for relative-link resolution.", "type": "text/plain" }, "key": "raw_html", "value": "" }, { "disabled": false, "description": { "content": "Execute JavaScript. Set to `auto` to let the extractor decide.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted plain text.", "type": "text/plain" }, "key": "text", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted HTML body.", "type": "text/plain" }, "key": "html", "value": "true" }, { "disabled": false, "description": { "content": "Return embedded media (YouTube, Twitter cards, etc.).", "type": "text/plain" }, "key": "media", "value": "false" }, { "disabled": false, "description": { "content": "Return RSS / Atom feed URLs.", "type": "text/plain" }, "key": "feeds", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted images.", "type": "text/plain" }, "key": "images", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted author.", "type": "text/plain" }, "key": "author", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted publish date.", "type": "text/plain" }, "key": "pub_date", "value": "true" }, { "disabled": false, "description": { "content": "Char count or percentage (with %) to return. 0 means all.", "type": "text/plain" }, "key": "partial", "value": "0" }, { "disabled": false, "description": { "content": "Include probability [0-1] of being an article.", "type": "text/plain" }, "key": "is_article", "value": "true" }, { "disabled": false, "description": { "content": "Faster, less thorough parsing.", "type": "text/plain" }, "key": "quick_mode", "value": "false" }, { "disabled": false, "description": { "content": "Comma-separated tag names / selectors to strip.", "type": "text/plain" }, "key": "strip_tags", "value": "form" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Seconds to wait for JS render. Defaults to timeout/2.", "type": "text/plain" }, "key": "js_timeout", "value": "" }, { "disabled": false, "description": { "content": "Scroll the page (requires js).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scroll actions.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Percent of page to scroll (0-100).", "type": "text/plain" }, "key": "scroll_percent", "value": "" }, { "disabled": false, "description": { "content": "Progressive scroll for dynamic content.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "When page load is considered complete. (This can only be one of load,domcontentloaded,networkidle,commit)", "type": "text/plain" }, "key": "wait_until", "value": "load" }, { "disabled": false, "description": { "content": "Filter out small images via min_image_width / _height.", "type": "text/plain" }, "key": "image_analysis", "value": "true" }, { "disabled": false, "description": { "content": "Minimum image width in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_width", "value": "200" }, { "disabled": false, "description": { "content": "Minimum image height in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_height", "value": "100" }, { "disabled": false, "description": { "content": "Per-image fetch timeout in seconds.", "type": "text/plain" }, "key": "image_timeout", "value": "2" }, { "disabled": false, "description": { "content": "Only return images enclosed within the article body.", "type": "text/plain" }, "key": "return_only_enclosed_text_images", "value": "true" }, { "disabled": false, "description": { "content": "Inline the main image into the extracted HTML body.", "type": "text/plain" }, "key": "main_image_in_html", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher country.", "type": "text/plain" }, "key": "publisher_country", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher timezone.", "type": "text/plain" }, "key": "publisher_tz", "value": "false" }, { "disabled": false, "description": { "content": "Deeper content analysis (slower).", "type": "text/plain" }, "key": "heavy_mode", "value": "false" }, { "disabled": false, "description": { "content": "Text-selection algorithm mode. (This can only be one of conservative,auto,optimistic,priority)", "type": "text/plain" }, "key": "text_length", "value": "priority" }, { "disabled": false, "description": { "content": "Proxy tier. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "scheme://user:pass@host:port (when proxy_type=custom).", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Username for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Password for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Auto-fallback to premium on rotating failure.", "type": "text/plain" }, "key": "auto_premium_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Sticky proxy session id (1-16 alphanumeric).", "type": "text/plain" }, "key": "session_id", "value": "" }, { "disabled": false, "description": { "content": "Concatenate multi-page articles.", "type": "text/plain" }, "key": "pagination", "value": "true" }, { "disabled": false, "description": { "content": "Max pages to follow when pagination=true.", "type": "text/plain" }, "key": "pagination_max_pages", "value": "30" }, { "disabled": false, "description": { "content": "Cookies to send with the request.", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Seconds for HTML fetch alone. Defaults to timeout.", "type": "text/plain" }, "key": "html_timeout", "value": "" }, { "disabled": false, "description": { "content": "Block ads during page render.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Disable HTML caching for this request.", "type": "text/plain" }, "key": "no_html_cache", "value": "false" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Timeout (ms) for CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "939ae539-1389-40b5-9c6e-9a211864a37a", "name": "Extracted article object.", "originalRequest": { "url": { "path": [ "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the article.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Inline HTML to extract from. When set, the URL is only used for relative-link resolution.", "type": "text/plain" }, "key": "raw_html", "value": "" }, { "disabled": false, "description": { "content": "Execute JavaScript. Set to `auto` to let the extractor decide.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted plain text.", "type": "text/plain" }, "key": "text", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted HTML body.", "type": "text/plain" }, "key": "html", "value": "true" }, { "disabled": false, "description": { "content": "Return embedded media (YouTube, Twitter cards, etc.).", "type": "text/plain" }, "key": "media", "value": "false" }, { "disabled": false, "description": { "content": "Return RSS / Atom feed URLs.", "type": "text/plain" }, "key": "feeds", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted images.", "type": "text/plain" }, "key": "images", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted author.", "type": "text/plain" }, "key": "author", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted publish date.", "type": "text/plain" }, "key": "pub_date", "value": "true" }, { "disabled": false, "description": { "content": "Char count or percentage (with %) to return. 0 means all.", "type": "text/plain" }, "key": "partial", "value": "0" }, { "disabled": false, "description": { "content": "Include probability [0-1] of being an article.", "type": "text/plain" }, "key": "is_article", "value": "true" }, { "disabled": false, "description": { "content": "Faster, less thorough parsing.", "type": "text/plain" }, "key": "quick_mode", "value": "false" }, { "disabled": false, "description": { "content": "Comma-separated tag names / selectors to strip.", "type": "text/plain" }, "key": "strip_tags", "value": "form" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Seconds to wait for JS render. Defaults to timeout/2.", "type": "text/plain" }, "key": "js_timeout", "value": "" }, { "disabled": false, "description": { "content": "Scroll the page (requires js).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scroll actions.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Percent of page to scroll (0-100).", "type": "text/plain" }, "key": "scroll_percent", "value": "" }, { "disabled": false, "description": { "content": "Progressive scroll for dynamic content.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "When page load is considered complete. (This can only be one of load,domcontentloaded,networkidle,commit)", "type": "text/plain" }, "key": "wait_until", "value": "load" }, { "disabled": false, "description": { "content": "Filter out small images via min_image_width / _height.", "type": "text/plain" }, "key": "image_analysis", "value": "true" }, { "disabled": false, "description": { "content": "Minimum image width in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_width", "value": "200" }, { "disabled": false, "description": { "content": "Minimum image height in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_height", "value": "100" }, { "disabled": false, "description": { "content": "Per-image fetch timeout in seconds.", "type": "text/plain" }, "key": "image_timeout", "value": "2" }, { "disabled": false, "description": { "content": "Only return images enclosed within the article body.", "type": "text/plain" }, "key": "return_only_enclosed_text_images", "value": "true" }, { "disabled": false, "description": { "content": "Inline the main image into the extracted HTML body.", "type": "text/plain" }, "key": "main_image_in_html", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher country.", "type": "text/plain" }, "key": "publisher_country", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher timezone.", "type": "text/plain" }, "key": "publisher_tz", "value": "false" }, { "disabled": false, "description": { "content": "Deeper content analysis (slower).", "type": "text/plain" }, "key": "heavy_mode", "value": "false" }, { "disabled": false, "description": { "content": "Text-selection algorithm mode. (This can only be one of conservative,auto,optimistic,priority)", "type": "text/plain" }, "key": "text_length", "value": "priority" }, { "disabled": false, "description": { "content": "Proxy tier. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "scheme://user:pass@host:port (when proxy_type=custom).", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Username for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Password for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Auto-fallback to premium on rotating failure.", "type": "text/plain" }, "key": "auto_premium_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Sticky proxy session id (1-16 alphanumeric).", "type": "text/plain" }, "key": "session_id", "value": "" }, { "disabled": false, "description": { "content": "Concatenate multi-page articles.", "type": "text/plain" }, "key": "pagination", "value": "true" }, { "disabled": false, "description": { "content": "Max pages to follow when pagination=true.", "type": "text/plain" }, "key": "pagination_max_pages", "value": "30" }, { "disabled": false, "description": { "content": "Cookies to send with the request.", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Seconds for HTML fetch alone. Defaults to timeout.", "type": "text/plain" }, "key": "html_timeout", "value": "" }, { "disabled": false, "description": { "content": "Block ads during page render.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Disable HTML caching for this request.", "type": "text/plain" }, "key": "no_html_cache", "value": "false" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Timeout (ms) for CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "56a86c0f-60b8-4927-a89a-6a65b27752c2", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the article.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Inline HTML to extract from. When set, the URL is only used for relative-link resolution.", "type": "text/plain" }, "key": "raw_html", "value": "" }, { "disabled": false, "description": { "content": "Execute JavaScript. Set to `auto` to let the extractor decide.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted plain text.", "type": "text/plain" }, "key": "text", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted HTML body.", "type": "text/plain" }, "key": "html", "value": "true" }, { "disabled": false, "description": { "content": "Return embedded media (YouTube, Twitter cards, etc.).", "type": "text/plain" }, "key": "media", "value": "false" }, { "disabled": false, "description": { "content": "Return RSS / Atom feed URLs.", "type": "text/plain" }, "key": "feeds", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted images.", "type": "text/plain" }, "key": "images", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted author.", "type": "text/plain" }, "key": "author", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted publish date.", "type": "text/plain" }, "key": "pub_date", "value": "true" }, { "disabled": false, "description": { "content": "Char count or percentage (with %) to return. 0 means all.", "type": "text/plain" }, "key": "partial", "value": "0" }, { "disabled": false, "description": { "content": "Include probability [0-1] of being an article.", "type": "text/plain" }, "key": "is_article", "value": "true" }, { "disabled": false, "description": { "content": "Faster, less thorough parsing.", "type": "text/plain" }, "key": "quick_mode", "value": "false" }, { "disabled": false, "description": { "content": "Comma-separated tag names / selectors to strip.", "type": "text/plain" }, "key": "strip_tags", "value": "form" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Seconds to wait for JS render. Defaults to timeout/2.", "type": "text/plain" }, "key": "js_timeout", "value": "" }, { "disabled": false, "description": { "content": "Scroll the page (requires js).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scroll actions.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Percent of page to scroll (0-100).", "type": "text/plain" }, "key": "scroll_percent", "value": "" }, { "disabled": false, "description": { "content": "Progressive scroll for dynamic content.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "When page load is considered complete. (This can only be one of load,domcontentloaded,networkidle,commit)", "type": "text/plain" }, "key": "wait_until", "value": "load" }, { "disabled": false, "description": { "content": "Filter out small images via min_image_width / _height.", "type": "text/plain" }, "key": "image_analysis", "value": "true" }, { "disabled": false, "description": { "content": "Minimum image width in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_width", "value": "200" }, { "disabled": false, "description": { "content": "Minimum image height in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_height", "value": "100" }, { "disabled": false, "description": { "content": "Per-image fetch timeout in seconds.", "type": "text/plain" }, "key": "image_timeout", "value": "2" }, { "disabled": false, "description": { "content": "Only return images enclosed within the article body.", "type": "text/plain" }, "key": "return_only_enclosed_text_images", "value": "true" }, { "disabled": false, "description": { "content": "Inline the main image into the extracted HTML body.", "type": "text/plain" }, "key": "main_image_in_html", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher country.", "type": "text/plain" }, "key": "publisher_country", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher timezone.", "type": "text/plain" }, "key": "publisher_tz", "value": "false" }, { "disabled": false, "description": { "content": "Deeper content analysis (slower).", "type": "text/plain" }, "key": "heavy_mode", "value": "false" }, { "disabled": false, "description": { "content": "Text-selection algorithm mode. (This can only be one of conservative,auto,optimistic,priority)", "type": "text/plain" }, "key": "text_length", "value": "priority" }, { "disabled": false, "description": { "content": "Proxy tier. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "scheme://user:pass@host:port (when proxy_type=custom).", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Username for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Password for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Auto-fallback to premium on rotating failure.", "type": "text/plain" }, "key": "auto_premium_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Sticky proxy session id (1-16 alphanumeric).", "type": "text/plain" }, "key": "session_id", "value": "" }, { "disabled": false, "description": { "content": "Concatenate multi-page articles.", "type": "text/plain" }, "key": "pagination", "value": "true" }, { "disabled": false, "description": { "content": "Max pages to follow when pagination=true.", "type": "text/plain" }, "key": "pagination_max_pages", "value": "30" }, { "disabled": false, "description": { "content": "Cookies to send with the request.", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Seconds for HTML fetch alone. Defaults to timeout.", "type": "text/plain" }, "key": "html_timeout", "value": "" }, { "disabled": false, "description": { "content": "Block ads during page render.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Disable HTML caching for this request.", "type": "text/plain" }, "key": "no_html_cache", "value": "false" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Timeout (ms) for CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab33a945-af36-4cb5-aad0-99f311e02b93", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "extract" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the article.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Inline HTML to extract from. When set, the URL is only used for relative-link resolution.", "type": "text/plain" }, "key": "raw_html", "value": "" }, { "disabled": false, "description": { "content": "Execute JavaScript. Set to `auto` to let the extractor decide.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted plain text.", "type": "text/plain" }, "key": "text", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted HTML body.", "type": "text/plain" }, "key": "html", "value": "true" }, { "disabled": false, "description": { "content": "Return embedded media (YouTube, Twitter cards, etc.).", "type": "text/plain" }, "key": "media", "value": "false" }, { "disabled": false, "description": { "content": "Return RSS / Atom feed URLs.", "type": "text/plain" }, "key": "feeds", "value": "false" }, { "disabled": false, "description": { "content": "Return extracted images.", "type": "text/plain" }, "key": "images", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted author.", "type": "text/plain" }, "key": "author", "value": "true" }, { "disabled": false, "description": { "content": "Return extracted publish date.", "type": "text/plain" }, "key": "pub_date", "value": "true" }, { "disabled": false, "description": { "content": "Char count or percentage (with %) to return. 0 means all.", "type": "text/plain" }, "key": "partial", "value": "0" }, { "disabled": false, "description": { "content": "Include probability [0-1] of being an article.", "type": "text/plain" }, "key": "is_article", "value": "true" }, { "disabled": false, "description": { "content": "Faster, less thorough parsing.", "type": "text/plain" }, "key": "quick_mode", "value": "false" }, { "disabled": false, "description": { "content": "Comma-separated tag names / selectors to strip.", "type": "text/plain" }, "key": "strip_tags", "value": "form" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Seconds to wait for JS render. Defaults to timeout/2.", "type": "text/plain" }, "key": "js_timeout", "value": "" }, { "disabled": false, "description": { "content": "Scroll the page (requires js).", "type": "text/plain" }, "key": "scroll_down", "value": "false" }, { "disabled": false, "description": { "content": "ms between scroll actions.", "type": "text/plain" }, "key": "scroll_wait", "value": "100" }, { "disabled": false, "description": { "content": "Percent of page to scroll (0-100).", "type": "text/plain" }, "key": "scroll_percent", "value": "" }, { "disabled": false, "description": { "content": "Progressive scroll for dynamic content.", "type": "text/plain" }, "key": "progressive_scroll", "value": "false" }, { "disabled": false, "description": { "content": "When page load is considered complete. (This can only be one of load,domcontentloaded,networkidle,commit)", "type": "text/plain" }, "key": "wait_until", "value": "load" }, { "disabled": false, "description": { "content": "Filter out small images via min_image_width / _height.", "type": "text/plain" }, "key": "image_analysis", "value": "true" }, { "disabled": false, "description": { "content": "Minimum image width in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_width", "value": "200" }, { "disabled": false, "description": { "content": "Minimum image height in px (when image_analysis=true).", "type": "text/plain" }, "key": "min_image_height", "value": "100" }, { "disabled": false, "description": { "content": "Per-image fetch timeout in seconds.", "type": "text/plain" }, "key": "image_timeout", "value": "2" }, { "disabled": false, "description": { "content": "Only return images enclosed within the article body.", "type": "text/plain" }, "key": "return_only_enclosed_text_images", "value": "true" }, { "disabled": false, "description": { "content": "Inline the main image into the extracted HTML body.", "type": "text/plain" }, "key": "main_image_in_html", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher country.", "type": "text/plain" }, "key": "publisher_country", "value": "false" }, { "disabled": false, "description": { "content": "Extract publisher timezone.", "type": "text/plain" }, "key": "publisher_tz", "value": "false" }, { "disabled": false, "description": { "content": "Deeper content analysis (slower).", "type": "text/plain" }, "key": "heavy_mode", "value": "false" }, { "disabled": false, "description": { "content": "Text-selection algorithm mode. (This can only be one of conservative,auto,optimistic,priority)", "type": "text/plain" }, "key": "text_length", "value": "priority" }, { "disabled": false, "description": { "content": "Proxy tier. (This can only be one of rotating,advanced,premium,residential,mobile,custom)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "US" }, { "disabled": false, "description": { "content": "scheme://user:pass@host:port (when proxy_type=custom).", "type": "text/plain" }, "key": "custom_proxy", "value": "" }, { "disabled": false, "description": { "content": "Username for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_username", "value": "" }, { "disabled": false, "description": { "content": "Password for custom_proxy.", "type": "text/plain" }, "key": "custom_proxy_password", "value": "" }, { "disabled": false, "description": { "content": "Auto-escalate proxy tier on failure.", "type": "text/plain" }, "key": "auto_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Auto-fallback to premium on rotating failure.", "type": "text/plain" }, "key": "auto_premium_proxy", "value": "false" }, { "disabled": false, "description": { "content": "Sticky proxy session id (1-16 alphanumeric).", "type": "text/plain" }, "key": "session_id", "value": "" }, { "disabled": false, "description": { "content": "Concatenate multi-page articles.", "type": "text/plain" }, "key": "pagination", "value": "true" }, { "disabled": false, "description": { "content": "Max pages to follow when pagination=true.", "type": "text/plain" }, "key": "pagination_max_pages", "value": "30" }, { "disabled": false, "description": { "content": "Cookies to send with the request.", "type": "text/plain" }, "key": "cookies", "value": "" }, { "disabled": false, "description": { "content": "Seconds for HTML fetch alone. Defaults to timeout.", "type": "text/plain" }, "key": "html_timeout", "value": "" }, { "disabled": false, "description": { "content": "Block ads during page render.", "type": "text/plain" }, "key": "block_ads", "value": "false" }, { "disabled": false, "description": { "content": "Disable HTML caching for this request.", "type": "text/plain" }, "key": "no_html_cache", "value": "false" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "false" }, { "disabled": false, "description": { "content": "Timeout (ms) for CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "120000" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "AI Scraper", "description": "Natural-language or JSON-schema-driven structured extraction.", "item": [ { "id": "651f97de-b33f-426e-8229-3fd28b62c03b", "name": "AI-driven structured extraction", "request": { "name": "AI-driven structured extraction", "description": { "content": "Extract structured data from any page using a natural-language `prompt`, a JSON `schema`, or both. Inherits standard scraping parameters from /scrape (proxies, JS, captcha solve, etc.). Note: `auto_captcha_solve` defaults to `true` on this endpoint.", "type": "text/plain" }, "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the page to extract from.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Natural-language instruction. Required unless `schema` is provided.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "JSON schema defining the expected output. Stringified JSON.", "type": "text/plain" }, "key": "schema", "value": "" }, { "disabled": false, "description": { "content": "LLM temperature (0.0-1.0).", "type": "text/plain" }, "key": "temperature", "value": "0" }, { "disabled": false, "description": { "content": "Enable JavaScript rendering.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "120" }, { "disabled": false, "description": { "content": "CSS selector or ms to wait.", "type": "text/plain" }, "key": "wait_for", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs. Note: defaults to `true` here, unlike other endpoints.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "5d8a0c8c-1466-4fa2-b3ea-69184f45b290", "name": "AI-extracted structured data.", "originalRequest": { "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the page to extract from.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Natural-language instruction. Required unless `schema` is provided.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "JSON schema defining the expected output. Stringified JSON.", "type": "text/plain" }, "key": "schema", "value": "" }, { "disabled": false, "description": { "content": "LLM temperature (0.0-1.0).", "type": "text/plain" }, "key": "temperature", "value": "0" }, { "disabled": false, "description": { "content": "Enable JavaScript rendering.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "120" }, { "disabled": false, "description": { "content": "CSS selector or ms to wait.", "type": "text/plain" }, "key": "wait_for", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs. Note: defaults to `true` here, unlike other endpoints.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f4fa166-92a1-406b-9e01-6b10408272d9", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the page to extract from.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Natural-language instruction. Required unless `schema` is provided.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "JSON schema defining the expected output. Stringified JSON.", "type": "text/plain" }, "key": "schema", "value": "" }, { "disabled": false, "description": { "content": "LLM temperature (0.0-1.0).", "type": "text/plain" }, "key": "temperature", "value": "0" }, { "disabled": false, "description": { "content": "Enable JavaScript rendering.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "120" }, { "disabled": false, "description": { "content": "CSS selector or ms to wait.", "type": "text/plain" }, "key": "wait_for", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs. Note: defaults to `true` here, unlike other endpoints.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3d10c23a-921b-4f1c-997d-550d2cec2137", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL of the page to extract from.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Natural-language instruction. Required unless `schema` is provided.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "JSON schema defining the expected output. Stringified JSON.", "type": "text/plain" }, "key": "schema", "value": "" }, { "disabled": false, "description": { "content": "LLM temperature (0.0-1.0).", "type": "text/plain" }, "key": "temperature", "value": "0" }, { "disabled": false, "description": { "content": "Enable JavaScript rendering.", "type": "text/plain" }, "key": "js", "value": "false" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code for premium/residential.", "type": "text/plain" }, "key": "proxy_country", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "120" }, { "disabled": false, "description": { "content": "CSS selector or ms to wait.", "type": "text/plain" }, "key": "wait_for", "value": "" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs. Note: defaults to `true` here, unlike other endpoints.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "3fdd0f7f-524e-4b89-a427-553a75011b8b", "name": "AI-driven structured extraction (POST body)", "request": { "name": "AI-driven structured extraction (POST body)", "description": { "content": "Same as GET /ai-scraper but with JSON body. Recommended when passing a large `schema`.", "type": "text/plain" }, "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"prompt\": \"\",\n \"schema\": {\n \"key_0\": true,\n \"key_1\": 1142,\n \"key_2\": true\n },\n \"temperature\": 0,\n \"js\": false,\n \"proxy_type\": \"\",\n \"proxy_country\": \"\",\n \"timeout\": 120,\n \"auto_captcha_solve\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "54f6d2df-2386-473b-99d7-81ade009f5b2", "name": "AI-extracted structured data.", "originalRequest": { "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"prompt\": \"\",\n \"schema\": {\n \"key_0\": true,\n \"key_1\": 1142,\n \"key_2\": true\n },\n \"temperature\": 0,\n \"js\": false,\n \"proxy_type\": \"\",\n \"proxy_country\": \"\",\n \"timeout\": 120,\n \"auto_captcha_solve\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c33f5b9e-48d2-4642-a6bc-58cc965b6e36", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"prompt\": \"\",\n \"schema\": {\n \"key_0\": true,\n \"key_1\": 1142,\n \"key_2\": true\n },\n \"temperature\": 0,\n \"js\": false,\n \"proxy_type\": \"\",\n \"proxy_country\": \"\",\n \"timeout\": 120,\n \"auto_captcha_solve\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dcbc088a-7d0e-4916-8201-ea725d49179f", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "ai-scraper" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\",\n \"prompt\": \"\",\n \"schema\": {\n \"key_0\": true,\n \"key_1\": 1142,\n \"key_2\": true\n },\n \"temperature\": 0,\n \"js\": false,\n \"proxy_type\": \"\",\n \"proxy_country\": \"\",\n \"timeout\": 120,\n \"auto_captcha_solve\": true\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "SERP", "description": "Google search results: organic, ads, news, images, maps.", "item": [ { "id": "9af8cb44-017d-496d-aa94-527771698e0e", "name": "Google search results", "request": { "name": "Google search results", "description": { "content": "Structured Google search results: organic, ads, AI overview, news, images, videos, maps. Supply either a `search` query OR a full Google `url`.", "type": "text/plain" }, "url": { "path": [ "serp" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query. Either this or `url` is required.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Full Google search page URL. Either this or `search` is required.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Type of search. (This can only be one of search,images,news,videos,maps,ai)", "type": "text/plain" }, "key": "search_type", "value": "search" }, { "disabled": false, "description": { "content": "ISO 639-1 language code.", "type": "text/plain" }, "key": "lang", "value": "en" }, { "disabled": false, "description": { "content": "Geographic location code (e.g. 'us', 'fr', 'uk').", "type": "text/plain" }, "key": "location", "value": "US" }, { "disabled": false, "description": { "content": "Device profile. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Max results per page.", "type": "text/plain" }, "key": "results_count", "value": "10" }, { "disabled": false, "description": { "content": "Results page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Additional Google query params (e.g. '&safe=active').", "type": "text/plain" }, "key": "extra_params", "value": "" }, { "disabled": false, "description": { "content": "Also return the raw HTML of the results page.", "type": "text/plain" }, "key": "with_html", "value": "false" }, { "disabled": false, "description": { "content": "Return only the raw HTML, no parsing.", "type": "text/plain" }, "key": "html_only", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f9fca624-8809-47c7-9ee5-b2b7ecbc22c0", "name": "Structured search results.", "originalRequest": { "url": { "path": [ "serp" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query. Either this or `url` is required.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Full Google search page URL. Either this or `search` is required.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Type of search. (This can only be one of search,images,news,videos,maps,ai)", "type": "text/plain" }, "key": "search_type", "value": "search" }, { "disabled": false, "description": { "content": "ISO 639-1 language code.", "type": "text/plain" }, "key": "lang", "value": "en" }, { "disabled": false, "description": { "content": "Geographic location code (e.g. 'us', 'fr', 'uk').", "type": "text/plain" }, "key": "location", "value": "US" }, { "disabled": false, "description": { "content": "Device profile. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Max results per page.", "type": "text/plain" }, "key": "results_count", "value": "10" }, { "disabled": false, "description": { "content": "Results page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Additional Google query params (e.g. '&safe=active').", "type": "text/plain" }, "key": "extra_params", "value": "" }, { "disabled": false, "description": { "content": "Also return the raw HTML of the results page.", "type": "text/plain" }, "key": "with_html", "value": "false" }, { "disabled": false, "description": { "content": "Return only the raw HTML, no parsing.", "type": "text/plain" }, "key": "html_only", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0d5a53d9-5a27-4542-8dfc-34758018dea6", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "serp" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query. Either this or `url` is required.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Full Google search page URL. Either this or `search` is required.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Type of search. (This can only be one of search,images,news,videos,maps,ai)", "type": "text/plain" }, "key": "search_type", "value": "search" }, { "disabled": false, "description": { "content": "ISO 639-1 language code.", "type": "text/plain" }, "key": "lang", "value": "en" }, { "disabled": false, "description": { "content": "Geographic location code (e.g. 'us', 'fr', 'uk').", "type": "text/plain" }, "key": "location", "value": "US" }, { "disabled": false, "description": { "content": "Device profile. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Max results per page.", "type": "text/plain" }, "key": "results_count", "value": "10" }, { "disabled": false, "description": { "content": "Results page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Additional Google query params (e.g. '&safe=active').", "type": "text/plain" }, "key": "extra_params", "value": "" }, { "disabled": false, "description": { "content": "Also return the raw HTML of the results page.", "type": "text/plain" }, "key": "with_html", "value": "false" }, { "disabled": false, "description": { "content": "Return only the raw HTML, no parsing.", "type": "text/plain" }, "key": "html_only", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fe4ea821-41cc-4de7-8261-54c7d8f6d7f8", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "serp" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search query. Either this or `url` is required.", "type": "text/plain" }, "key": "search", "value": "" }, { "disabled": false, "description": { "content": "Full Google search page URL. Either this or `search` is required.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Type of search. (This can only be one of search,images,news,videos,maps,ai)", "type": "text/plain" }, "key": "search_type", "value": "search" }, { "disabled": false, "description": { "content": "ISO 639-1 language code.", "type": "text/plain" }, "key": "lang", "value": "en" }, { "disabled": false, "description": { "content": "Geographic location code (e.g. 'us', 'fr', 'uk').", "type": "text/plain" }, "key": "location", "value": "US" }, { "disabled": false, "description": { "content": "Device profile. (This can only be one of desktop,mobile)", "type": "text/plain" }, "key": "device", "value": "desktop" }, { "disabled": false, "description": { "content": "Max results per page.", "type": "text/plain" }, "key": "results_count", "value": "10" }, { "disabled": false, "description": { "content": "Results page number.", "type": "text/plain" }, "key": "page", "value": "1" }, { "disabled": false, "description": { "content": "Additional Google query params (e.g. '&safe=active').", "type": "text/plain" }, "key": "extra_params", "value": "" }, { "disabled": false, "description": { "content": "Also return the raw HTML of the results page.", "type": "text/plain" }, "key": "with_html", "value": "false" }, { "disabled": false, "description": { "content": "Return only the raw HTML, no parsing.", "type": "text/plain" }, "key": "html_only", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Markdown", "description": "Convert any page to clean, LLM-optimized markdown.", "item": [ { "id": "3dedbccc-9d16-4803-9bb1-29eab97ec5d5", "name": "Convert any page to LLM-optimized markdown", "request": { "name": "Convert any page to LLM-optimized markdown", "description": { "content": "Render a page and return clean, chunked, RAG-ready markdown. Supports raw / fit / BM25 content filters.", "type": "text/plain" }, "url": { "path": [ "markdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to convert.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Content filter: raw (no filter), fit (default), or bm25 (query-driven). (This can only be one of raw,fit,bm25)", "type": "text/plain" }, "key": "filter", "value": "fit" }, { "disabled": false, "description": { "content": "Query string for BM25 filtering.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Generate numbered citations. Defaults to false on POST.", "type": "text/plain" }, "key": "citations", "value": "true" }, { "disabled": false, "description": { "content": "Execute JavaScript.", "type": "text/plain" }, "key": "js", "value": "true" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "Custom proxy URL.", "type": "text/plain" }, "key": "proxy", "value": "" }, { "disabled": false, "description": { "content": "ms to wait after page load.", "type": "text/plain" }, "key": "wait", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to wait for.", "type": "text/plain" }, "key": "wait_for_selector", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "2d667e7b-ceee-4030-a456-ebbcc553701d", "name": "Markdown body, JSON-wrapped with metadata.", "originalRequest": { "url": { "path": [ "markdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to convert.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Content filter: raw (no filter), fit (default), or bm25 (query-driven). (This can only be one of raw,fit,bm25)", "type": "text/plain" }, "key": "filter", "value": "fit" }, { "disabled": false, "description": { "content": "Query string for BM25 filtering.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Generate numbered citations. Defaults to false on POST.", "type": "text/plain" }, "key": "citations", "value": "true" }, { "disabled": false, "description": { "content": "Execute JavaScript.", "type": "text/plain" }, "key": "js", "value": "true" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "Custom proxy URL.", "type": "text/plain" }, "key": "proxy", "value": "" }, { "disabled": false, "description": { "content": "ms to wait after page load.", "type": "text/plain" }, "key": "wait", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to wait for.", "type": "text/plain" }, "key": "wait_for_selector", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2e77106-82f6-4089-bd97-1ab00ea020c1", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "markdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to convert.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Content filter: raw (no filter), fit (default), or bm25 (query-driven). (This can only be one of raw,fit,bm25)", "type": "text/plain" }, "key": "filter", "value": "fit" }, { "disabled": false, "description": { "content": "Query string for BM25 filtering.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Generate numbered citations. Defaults to false on POST.", "type": "text/plain" }, "key": "citations", "value": "true" }, { "disabled": false, "description": { "content": "Execute JavaScript.", "type": "text/plain" }, "key": "js", "value": "true" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "Custom proxy URL.", "type": "text/plain" }, "key": "proxy", "value": "" }, { "disabled": false, "description": { "content": "ms to wait after page load.", "type": "text/plain" }, "key": "wait", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to wait for.", "type": "text/plain" }, "key": "wait_for_selector", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60f9c334-a6c1-436f-a5f4-8843e613e775", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "markdown" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) URL to convert.", "type": "text/plain" }, "key": "url", "value": "" }, { "disabled": false, "description": { "content": "Content filter: raw (no filter), fit (default), or bm25 (query-driven). (This can only be one of raw,fit,bm25)", "type": "text/plain" }, "key": "filter", "value": "fit" }, { "disabled": false, "description": { "content": "Query string for BM25 filtering.", "type": "text/plain" }, "key": "query", "value": "" }, { "disabled": false, "description": { "content": "Generate numbered citations. Defaults to false on POST.", "type": "text/plain" }, "key": "citations", "value": "true" }, { "disabled": false, "description": { "content": "Execute JavaScript.", "type": "text/plain" }, "key": "js", "value": "true" }, { "disabled": false, "description": { "content": "Proxy type (auto if unset). (This can only be one of rotating,advanced,premium,residential,residential_us,residential_geo)", "type": "text/plain" }, "key": "proxy_type", "value": "residential" }, { "disabled": false, "description": { "content": "Custom proxy URL.", "type": "text/plain" }, "key": "proxy", "value": "" }, { "disabled": false, "description": { "content": "ms to wait after page load.", "type": "text/plain" }, "key": "wait", "value": "" }, { "disabled": false, "description": { "content": "CSS selector to wait for.", "type": "text/plain" }, "key": "wait_for_selector", "value": "" }, { "disabled": false, "description": { "content": "Request timeout in seconds.", "type": "text/plain" }, "key": "timeout", "value": "60" }, { "disabled": false, "description": { "content": "Auto-solve CAPTCHAs.", "type": "text/plain" }, "key": "auto_captcha_solve", "value": "true" }, { "disabled": false, "description": { "content": "ms before giving up on CAPTCHA solve.", "type": "text/plain" }, "key": "auto_captcha_solve_timeout", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "ChatGPT", "description": "Forward a prompt to ChatGPT and return its reply.", "item": [ { "id": "cacc578a-8037-4a39-8307-6c33a73b237f", "name": "Forward a prompt to ChatGPT", "request": { "name": "Forward a prompt to ChatGPT", "description": { "content": "Send a prompt to ChatGPT and return its reply. URL-encode special characters in the prompt.", "type": "text/plain" }, "url": { "path": [ "chatgpt" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to ChatGPT.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Enable ChatGPT's web search for up-to-date info.", "type": "text/plain" }, "key": "enable_web_search", "value": "false" }, { "disabled": false, "description": { "content": "Include the full page HTML in the response.", "type": "text/plain" }, "key": "return_html", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "67eb006f-a7f7-422a-813a-35d9a6508e87", "name": "LLM reply.", "originalRequest": { "url": { "path": [ "chatgpt" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to ChatGPT.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Enable ChatGPT's web search for up-to-date info.", "type": "text/plain" }, "key": "enable_web_search", "value": "false" }, { "disabled": false, "description": { "content": "Include the full page HTML in the response.", "type": "text/plain" }, "key": "return_html", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "131e73c3-07f8-407d-8020-00f33fc693b7", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "chatgpt" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to ChatGPT.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Enable ChatGPT's web search for up-to-date info.", "type": "text/plain" }, "key": "enable_web_search", "value": "false" }, { "disabled": false, "description": { "content": "Include the full page HTML in the response.", "type": "text/plain" }, "key": "return_html", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "47e55628-fab5-4a20-bb6a-8a0de8eefdac", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "chatgpt" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to ChatGPT.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Enable ChatGPT's web search for up-to-date info.", "type": "text/plain" }, "key": "enable_web_search", "value": "false" }, { "disabled": false, "description": { "content": "Include the full page HTML in the response.", "type": "text/plain" }, "key": "return_html", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Gemini", "description": "Forward a prompt to Gemini and return its reply.", "item": [ { "id": "3467691a-741c-4fea-a89b-b3c4531bcfae", "name": "Forward a prompt to Gemini", "request": { "name": "Forward a prompt to Gemini", "description": { "content": "Send a prompt to Gemini and return its reply. URL-encode special characters in the prompt.", "type": "text/plain" }, "url": { "path": [ "gemini" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to Gemini.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Proxy type to use. (This can only be one of premium,rotating,datacenter)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code.", "type": "text/plain" }, "key": "proxy_country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "63a32c0b-da4f-4a7b-90a6-9160836f811c", "name": "LLM reply.", "originalRequest": { "url": { "path": [ "gemini" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to Gemini.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Proxy type to use. (This can only be one of premium,rotating,datacenter)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code.", "type": "text/plain" }, "key": "proxy_country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"key_0\": 9299.984106230591,\n \"key_1\": 4681.141092463002\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f109d549-6c00-438d-a330-ae1a15ca48d6", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "gemini" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to Gemini.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Proxy type to use. (This can only be one of premium,rotating,datacenter)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code.", "type": "text/plain" }, "key": "proxy_country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a7765e05-5d36-4d72-9382-3a3cab90d407", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "gemini" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The prompt to send to Gemini.", "type": "text/plain" }, "key": "prompt", "value": "" }, { "disabled": false, "description": { "content": "Wait for the page to fully load before interaction.", "type": "text/plain" }, "key": "wait_for_load", "value": "true" }, { "disabled": false, "description": { "content": "Max time in ms to wait for the response.", "type": "text/plain" }, "key": "timeout", "value": "60000" }, { "disabled": false, "description": { "content": "Proxy type to use. (This can only be one of premium,rotating,datacenter)", "type": "text/plain" }, "key": "proxy_type", "value": "rotating" }, { "disabled": false, "description": { "content": "ISO 3166-1 alpha-2 code.", "type": "text/plain" }, "key": "proxy_country", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account", "description": "Plan, quota, used credits, balance, next billing date.", "item": [ { "id": "6bbb4c0e-853d-4058-858b-964f4c68e4af", "name": "Account usage", "request": { "name": "Account usage", "description": { "content": "Read current plan, quota, credits used, balance, and next billing date. No parameters. Capped at 10 calls / minute / key.", "type": "text/plain" }, "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "f85958da-f200-4231-b339-83f67d1dbb15", "name": "Current account state.", "originalRequest": { "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"userid\": \"\",\n \"plan\": \"\",\n \"quota\": \"\",\n \"used\": \"\",\n \"used_percent\": \"\",\n \"total_requests\": \"\",\n \"balance\": \"\",\n \"concurrent_requests\": \"\",\n \"next_billing_date\": \"\",\n \"days_till_next_billing\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9daf975-7ade-4b6c-b9a2-e154ae56bef6", "name": "Missing or invalid ApiKey header.", "originalRequest": { "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "836757e9-95dc-4bfa-9827-68937ea61f91", "name": "Rate limit or budget cap hit. See `Retry-After` header.", "originalRequest": { "url": { "path": [ "account" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "ApiKey", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "apikey", "apikey": [ { "type": "any", "value": "ApiKey", "key": "key" }, { "type": "any", "value": "{{apiKey}}", "key": "value" }, { "type": "any", "value": "header", "key": "in" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.ujeebu.com" }, { "key": "apiKey", "value": "", "type": "string", "description": "Your Ujeebu API key. Get one at https://ujeebu.com/signup (free 14-day trial, 5,000 credits)." } ], "info": { "_postman_id": "2792567c-bbd9-4404-8512-b062be51a59a", "name": "Ujeebu API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Official Ujeebu API collection \u2014 web scraping, AI extraction, SERP, markdown conversion, ChatGPT / Gemini passthrough, and account usage. One credit pool across every endpoint. Failed requests are not billed.\n\nQuick start:\n1. Paste your API key into the `apiKey` collection variable (Variables tab) or import the bundled environment.\n2. Pick any request, hit Send.\n\nDocs: https://ujeebu.com/docs/apis\nSignup: https://ujeebu.com/signup" } }