Skip to main content
POST
/
api
/
v1
/
jobs
Create a keyword research job
curl --request POST \
  --url https://suprkeywords.com/app/api/v1/jobs \
  --header 'Content-Type: application/json' \
  --cookie __session= \
  --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

__session
string
cookie
required

Clerk session cookie. Dashboard requests are authenticated via Clerk; unauthenticated requests return 401 for protected routes. Demo job access is allowed for GET job and sub-resources when applicable.

Body

application/json
primaryDomain
string
required

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

Example:

"example.com"

languageCode
string
required

DataForSEO language code (e.g. en)

locationCode
integer
required

DataForSEO 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