Skip to main content
POST
/
api
/
v1
/
products
/
{productId}
/
scraper
/
runs
Queue a product scraping run
curl --request POST \
  --url https://app.promptingco.com/api/v1/products/{productId}/scraper/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "startUrls": [
    "<string>"
  ],
  "baseUrls": [
    "<string>"
  ],
  "cssSelector": "<string>",
  "cssExcludeSelector": "<string>",
  "customHeaders": {},
  "saveConfig": false
}
'
{
  "data": {
    "jobId": "<string>",
    "productId": "<string>",
    "scraperId": "<string>",
    "enqueuedAt": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.promptingcompany.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Organization-scoped API key. Available scopes:

  • content:read: Read site pages, markdown content, and llms.txt files
  • content:write: Create, update, and delete site pages and content
  • prompts:read: Read prompts, topics, and prompt analysis results
  • prompts:write: Create, update, archive prompts
  • simulations:read: Read agent-simulation tasks, runs, environments, and analytics
  • simulations:write: Create and trigger simulation runs
  • logs:read: Read AI-traffic logs and request-level audit events
  • analytics:read: Read analytics aggregates (rankings, mentions, sources, SOV)
  • products:read: Read product metadata and competitor data
  • products:write: Update product settings and competitor lists

Path Parameters

​
productId
string
required
Minimum string length: 1

Body

application/json
​
startUrls
string<uri>[]
Required array length: 1 - 1000 elements
Maximum string length: 2000
​
baseUrls
string<uri>[]
Required array length: 1 - 1000 elements
Maximum string length: 2000
​
cssSelector
string
Required string length: 1 - 1000
​
cssExcludeSelector
string | null
Maximum string length: 2000
​
customHeaders
object
​
saveConfig
boolean
default:false

Response

Successful response

​
ok
enum<boolean>
required
Available options:
true
​
data
object
required