Skip to main content
POST

Authorizations

Authorization
string
header
required

API key authentication. Generate your API key in the ManyPI dashboard under 'API Access'. Include it in the Authorization header as: Authorization: Bearer YOUR_API_KEY

Path Parameters

scraperId
string<uuid>
required

Unique identifier of the scraper to execute. Find this in your dashboard under Scrapers.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Body

application/json

Optional configuration for the scraping request

url
string<uri>
required

Target URL to scrape. Must be a valid HTTP/HTTPS URL.

Example:

"https://example.com/product/123"

options
object

Optional configuration for the scraping request

Response

Scraping completed successfully

success
boolean
required

Indicates whether the scraping operation was successful

Example:

true

data
object
required

Extracted data matching your scraper's schema. Structure varies based on your scraper configuration.

Example:
metadata
object
required

Information about the scraping operation