Create an API key
Use an API key to authenticate every request to pline. Keys are tied to your account, and can be rotated without downtime.1
Open the dashboard
Sign in to the pline dashboard and go to API keys.
2
Create a new key
Click Create, give it a label (for example
production-scraper).3
Copy and store securely
Copy the key immediately. It is shown once and cannot be retrieved later. Store it in a secrets manager or environment variable — never commit it to source control.
Authorization: Bearer <your key> header.
Rotate or revoke
- Rotate: create a new key, update your applications, then revoke the old key.
- Revoke: immediately invalidates the key. In-flight requests may complete; new requests return
401 Unauthorized.
Send your first request
Send a singlePOST /scrape request to fetch a page. Only url is required — everything else uses a sensible default.
What you get back
A successful response includes:data— the scraped content. For the defaulthtmloutput, readdata.html_body.session_id— reuse it on the next request to persist cookies and continue the same scraping session.request_id— returned when you passX-Request-ID. Use it to trace back request details in logs and support workflows.
Correlate requests
PassX-Request-ID to trace a scrape end-to-end. The orchestrator echoes it back as request_id.
Where to go next
- API reference — full endpoint specs and the interactive playground.
- Credits and usage — how requests affect billing.
