API reference

Use the API reference to inspect pline endpoints and send test requests from the interactive playground.

Base URL

Requests use the base URL below.

https://apix.pline.ai/v1

Authentication

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

X-API-Key: YOUR_API_KEY

Field names

Request field names are not the same across endpoints, and unknown fields are rejected with a 422. Copy names exactly as shown on each endpoint page.

Endpoint	Request field names
`POST /scrape`, `GET /serp`	`snake_case`, for example `js_render`, `proxy_strategy`, `wait_selector`
`POST /map`, `POST /crawl`	`camelCase`, for example `includeSubdomains`, `crawlEntireDomain`. The options inside a crawl’s `scrape` object are `snake_case`
`POST /batch/scrape`	`snake_case` for the scrape options, as on `POST /scrape`, for example `js_render`, `proxy_strategy`, `wait_selector`, `only_main_content`, and `session_id`. Batch-level fields such as `urls`, `limit`, `email`, and `webhook` have no multi-word names

Endpoints

POST /scrape

Fetch a URL and return its page content.

Batch scrape

Scrape many URLs with the same options in one durable job.

POST /map

Discover URLs for a website with sitemap-first, best-effort discovery.

Crawl

Start a durable, multi-page crawl and poll it for status and results.

GET /serp

Search the web and get back parsed, structured results.

Scrape

Batch scrape

Map

Crawl

SERP

API reference

Base URL

Authentication

Field names

Endpoints

POST /scrape

Batch scrape

POST /map

Crawl

GET /serp

​Base URL

​Authentication

​Field names

​Endpoints

POST /scrape

Batch scrape

POST /map

Crawl

GET /serp

Base URL

Authentication

Field names

Endpoints