Perplexity Scraper

The scraper.perplexity actor returns Perplexity responses enriched with related prompts, citations, and media assets so you can benchmark how the model answers across markets.

Request Example

curl '{api_host}/api/v2/scraper/request' \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: {you_api_key}' \
  --data '{
    "actor": "scraper.perplexity",
    "input": {
      "prompt": "Recommended attractions in New York",
      "country": "US",
      "web_search": true
    },
    "webhook": {
      "url": "http://www.youwebhook.com"
    }
  }'

Body Parameters

Parameter	Type	Required	Description
`prompt`	string	Yes	Prompt to send to Perplexity.
`country`	string	Yes	Country or region code.
`web_search`	boolean	No	Enable or disable web search.

Response Fields

Parameter	Type	Description
`prompt`	string	Original prompt.
`result_text`	string	Markdown answer from Perplexity.
`related_prompt`	array	Related follow-up questions.
`web_results`	array	Search data Perplexity referenced.
`web_results.name`	string	Title of the source.
`web_results.url`	string	Source URL.
`web_results.snippet`	string	Short snippet or description.
`media_items`	array	Media references returned by Perplexity.
`media_items.medium`	string	Media type such as `map` or `video`.
`media_items.url`	string	Link to the media resource.
`media_items.image`	string	Preview image.
`media_items.source`	string	Origin (e.g., `web`, `youtube`).
`media_items.thumbnail`	string	Thumbnail URL.
`media_items.locations`	array	Location data for `map` media.
`media_items.locations.lat`	float	Latitude.
`media_items.locations.lng`	float	Longitude.
`media_items.locations.name`	string	Location name.
`media_items.locations.description`	string	Description of the location.
`media_items.locations.image_url`	string	Image link.
`media_items.locations.num_reviews`	int	Number of reviews.
`media_items.locations.url`	string	Target URL.
`media_items.locations.categories`	array	Associated categories.
`media_items.locations.address`	array	Address lines.

ChatGPT Copilot