POST
/
searchgpt
/
jobs
curl --request POST \
  --url https://app.gptscraper.com/api/searchgpt/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "query": "<string>",
  "screenshot": true,
  "country": "<string>"
}'
{
  "jobId": "<string>",
  "success": true
}

Authorizations

Authorization
string
header
required

Enter your API key in the format: Bearer <YOUR_API_KEY>

Body

application/json
query
string
required

The query to send to searchGPT

screenshot
boolean
required

Whether to capture a screenshot of the search results

country
string

Country code in ISO 3166-1 alpha-2 format

Response

200
application/json
Job created successfully
jobId
string
required

Unique identifier for the created job

success
boolean

Whether the job was created successfully