Skip to main content
POST
/
api
/
v1
/
jobs
Create a keyword research job
curl --request POST \
  --url https://www.suprkeywords.com/api/v1/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "primaryDomain": "example.com",
  "languageCode": "<string>",
  "locationCode": 123,
  "competitorDomains": [
    "competitor.com"
  ]
}
'
{
  "job": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "<string>",
    "createdAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key for programmatic access. Create keys in Settings (Agency plan). Send as Authorization: Bearer or X-API-KEY: . Unauthenticated requests return 401.

Body

application/json
​
primaryDomain
string
required

Primary domain to analyze (e.g. example.com)

Example:

"example.com"

​
languageCode
string
required

Language code (e.g. en)

​
locationCode
integer
required

Location code (e.g. 2840 for United States)

​
competitorDomains
string[]

Optional competitor domains

Maximum array length: 10
Example:
["competitor.com"]

Response

Job created; pipeline started

​
job
object