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"
}
}Jobs
Create a keyword research job
Create a new keyword research job. Requires authentication. Debits one run (credit) upfront and enforces domain limit. Triggers the pipeline (personas → seed keywords → enrichment → expansion → clustering).
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"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.suprkeywords.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
bearerAuthSessionAuth
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
Primary domain to analyze (e.g. example.com)
Example:
"example.com"
Language code (e.g. en)
Location code (e.g. 2840 for United States)
Optional competitor domains
Maximum array length:
10Example:
["competitor.com"]Response
Job created; pipeline started
Show child attributes
Show child attributes
⌘I