POST /scrape

POST

scrape

{
  "url": "https://example.com/page",
  "js_render": null,
  "proxy_strategy": null,
  "output": ["html"],
  "only_main_content": true,
  "geolocation": null,
  "session_id": null,
  "tag": null,
  "actions": [],
  "timeout": 30000,
  "wait_selector": null,
  "wait_ms": null,
  "prompt": null,
  "schema": null
}

{
  "url": "https://news.example.com/article/123",
  "js_render": true,
  "output": ["json"],
  "prompt": "Extract the article title, author, publish date, and body text.",
  "schema": {
    "title": "string",
    "author": "string",
    "published_at": "string",
    "body": "string"
  }
}

{
  "request_id": "req_01HZ1234ABCD5678EFGH",
  "session_id": "my-session-abc123",
  "effective_geolocation": { "country": "US", "city": "New York" },
  "final_url": "https://example.com/page",
  "site_tier": "standard",
  "proxy_tier": "premium",
  "status": 200,
  "data": {
    "html_body": "<html>...</html>"
  }
}

{
  "detail": "Invalid request \u2014 e.g. malformed URL, unsupported method/output combination, or a session bound to a different domain."
}

{
  "detail": "Invalid request."
}

{
  "detail": "Session busy \u2014 a concurrent request holds the session lock; retry after a short delay."
}

{
  "detail": "Unexpected error."
}

{
  "detail": "All scrape attempts failed (blocked, timed out, or origin unreachable)."
}

{
  "detail": "A capability this request needs is temporarily unavailable. Retry shortly."
}

Fetch a page in one request. Use Try it to send a live request: set X-API-Key to <your API key>, then edit the fields below or use the full JSON example.

The playground sends live requests to https://apix.pline.ai/v1. The fields below map to the full POST /scrape JSON body so you can set or clear each parameter explicitly.

Authorization

Send your pline API key in the X-API-Key header on every request.

Body

string

required

The target website URL that you want the API to scrape.

string

default:"GET"

HTTP method used to fetch the URL: GET (default), POST, PUT, or DELETE. Browser rendering (js_render or actions) supports GET only.

object | string

Request body for POST, PUT, or DELETE requests, as a JSON object or a raw string. Not allowed with GET or with browser rendering.

boolean

Whether JavaScript must run. true requires a browser, false forbids one, and omitting it lets pline choose automatically.

string

Proxy cost tier to use. Omitting it escalates through the automatic set.

string[]

default:"[\"html\"]"

Response content formats. html is raw; clean_html, links, markdown, clean_markdown, and json are derived outputs. clean_markdown is Markdown with links, URLs, and images removed, keeping the link text and structure. screenshot and screenshot_full_page are mutually exclusive.

boolean

default:"true"

Remove navigation, footers, ads, and other non-main layout content from cleaned outputs (clean_html, markdown, json).

string

The country or region code (e.g., US, GB, DE) to route the request through. Useful for bypassing geo-blocks or viewing localized content.

string

A unique identifier to reuse the same proxy IP address across multiple requests. This is essential for scraping tasks that require logging in or maintaining a continuous user session.

string | string[]

Caller-defined label(s) for filtering and tracing requests. Accepts a single string or an array of strings.

object[]

Browser actions to run, in order, after the page loads. Providing any action forces browser rendering.

Action	Needs	What it does
`click`	`selector`	Click an element.
`click_and_hold`	`selector`	Press and hold an element. Optional `duration_ms` (0–30,000, default 1,000).
`type`	`selector`, `value`	Type the `value` text into an element.
`hover`	`selector`	Move the pointer over an element.
`select_option`	`selector`, `value`	Choose the option `value` in a select element.
`press`	`selector`, `value`	Press the key in `value`, for example `Enter`, on an element.
`wait_for_selector`	`selector`	Wait until the element appears.
`scroll_into_view`	`selector`	Scroll an element into view.
`drag_to`	`selector`, `value`	Drag an element to the drop target whose selector is in `value`.
`scroll`	`value`	Scroll the page by `value` pixels (-100,000 to 100,000).
`wait`	`value`	Wait `value` milliseconds (0–30,000).
`reload`	none	Reload the page.

selector_type sets how selector is read: css (default), xpath, role, text, regex, test_id, label, or placeholder. Set frame_selector to search inside an iframe, and if_present: true to skip an action instead of failing when its selector isn’t visible.

Show actions properties

string

required

The browser action to run. See the supported actions table. One of click, click_and_hold, type, hover, select_option, press, wait_for_selector, scroll_into_view, drag_to, scroll, wait, reload.

string

Target element. Required by every action except scroll, wait, and reload.

string

default:"css"

How selector is interpreted. One of css, xpath, role, text, regex, test_id, label, placeholder.

string

Action input: the text for type, the option for select_option, the key for press (for example Enter), the drop-target selector for drag_to, pixels for scroll, or milliseconds for wait.

integer

How long click_and_hold holds the press, in milliseconds (0–30,000, default 1,000).

string

Selector of an iframe to search inside when resolving selector.

boolean

default:"false"

Skip this action instead of failing when its selector is not visible.

integer

Request timeout in milliseconds (1,000–60,000).

string

CSS selector to wait for before returning a browser-rendered page.

integer

Extra browser settle wait in milliseconds before returning (0–60,000).

string

Natural language extraction instruction, used when output includes json. prompt or schema is required when output includes json. prompt is limited to 16384 characters; schema is limited to 65536 bytes when serialized.

object

Desired JSON extraction schema, used when output includes json. prompt or schema is required when output includes json. prompt is limited to 16384 characters; schema is limited to 65536 bytes when serialized.

Response

string

Unique ID for this request. Echoes X-Request-ID when you send one, otherwise generated by pline.

string

required

Effective session id used for this scrape.

object

The proxy/browser geolocation actually used, when one was selected.

Show effective_geolocation properties

string

required

Final URL after redirects or browser navigation.

string

required

A classification pline assigns to the target site.

string

Proxy tier actually used for this request, when applicable.

string

required

HTTP status returned by the target page.

object

required

Output payload keyed by output type, such as html_body, clean_html, links, markdown, or clean_markdown.

Response codes

Code	Meaning
`200`	Scrape result including page content
`400`	Invalid request — e.g. malformed URL, unsupported method/output combination, or a session bound to a different domain.
`422`	Invalid request.
`429`	Session busy — a concurrent request holds the session lock; retry after a short delay.
`500`	Unexpected error.
`502`	All scrape attempts failed (blocked, timed out, or origin unreachable).
`503`	A capability this request needs is temporarily unavailable. Retry shortly.

{
  "url": "https://example.com/page",
  "js_render": null,
  "proxy_strategy": null,
  "output": ["html"],
  "only_main_content": true,
  "geolocation": null,
  "session_id": null,
  "tag": null,
  "actions": [],
  "timeout": 30000,
  "wait_selector": null,
  "wait_ms": null,
  "prompt": null,
  "schema": null
}

{
  "url": "https://news.example.com/article/123",
  "js_render": true,
  "output": ["json"],
  "prompt": "Extract the article title, author, publish date, and body text.",
  "schema": {
    "title": "string",
    "author": "string",
    "published_at": "string",
    "body": "string"
  }
}

{
  "request_id": "req_01HZ1234ABCD5678EFGH",
  "session_id": "my-session-abc123",
  "effective_geolocation": { "country": "US", "city": "New York" },
  "final_url": "https://example.com/page",
  "site_tier": "standard",
  "proxy_tier": "premium",
  "status": 200,
  "data": {
    "html_body": "<html>...</html>"
  }
}

{
  "detail": "Invalid request \u2014 e.g. malformed URL, unsupported method/output combination, or a session bound to a different domain."
}

{
  "detail": "Invalid request."
}

{
  "detail": "Session busy \u2014 a concurrent request holds the session lock; retry after a short delay."
}

{
  "detail": "Unexpected error."
}

{
  "detail": "All scrape attempts failed (blocked, timed out, or origin unreachable)."
}

{
  "detail": "A capability this request needs is temporarily unavailable. Retry shortly."
}

{
  "url": "https://example.com/page",
  "js_render": null,
  "proxy_strategy": null,
  "output": ["html"],
  "only_main_content": true,
  "geolocation": null,
  "session_id": null,
  "tag": null,
  "actions": [],
  "timeout": 30000,
  "wait_selector": null,
  "wait_ms": null,
  "prompt": null,
  "schema": null
}

{
  "url": "https://news.example.com/article/123",
  "js_render": true,
  "output": ["json"],
  "prompt": "Extract the article title, author, publish date, and body text.",
  "schema": {
    "title": "string",
    "author": "string",
    "published_at": "string",
    "body": "string"
  }
}

{
  "request_id": "req_01HZ1234ABCD5678EFGH",
  "session_id": "my-session-abc123",
  "effective_geolocation": { "country": "US", "city": "New York" },
  "final_url": "https://example.com/page",
  "site_tier": "standard",
  "proxy_tier": "premium",
  "status": 200,
  "data": {
    "html_body": "<html>...</html>"
  }
}

{
  "detail": "Invalid request \u2014 e.g. malformed URL, unsupported method/output combination, or a session bound to a different domain."
}

{
  "detail": "Invalid request."
}

{
  "detail": "Session busy \u2014 a concurrent request holds the session lock; retry after a short delay."
}

{
  "detail": "Unexpected error."
}

{
  "detail": "All scrape attempts failed (blocked, timed out, or origin unreachable)."
}

{
  "detail": "A capability this request needs is temporarily unavailable. Retry shortly."
}

Scrape

Batch scrape

Map

Crawl

SERP

POST /scrape

Authorization

Body

Response

Response codes

​Authorization

​Body

​Response

​Response codes

Authorization

Body

Response

Response codes