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"
]
}
'import requests
url = "https://www.suprkeywords.com/api/v1/jobs"
payload = {
"primaryDomain": "example.com",
"languageCode": "<string>",
"locationCode": 123,
"competitorDomains": ["competitor.com"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
primaryDomain: 'example.com',
languageCode: '<string>',
locationCode: 123,
competitorDomains: ['competitor.com']
})
};
fetch('https://www.suprkeywords.com/api/v1/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.suprkeywords.com/api/v1/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'primaryDomain' => 'example.com',
'languageCode' => '<string>',
'locationCode' => 123,
'competitorDomains' => [
'competitor.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.suprkeywords.com/api/v1/jobs"
payload := strings.NewReader("{\n \"primaryDomain\": \"example.com\",\n \"languageCode\": \"<string>\",\n \"locationCode\": 123,\n \"competitorDomains\": [\n \"competitor.com\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.suprkeywords.com/api/v1/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"primaryDomain\": \"example.com\",\n \"languageCode\": \"<string>\",\n \"locationCode\": 123,\n \"competitorDomains\": [\n \"competitor.com\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.suprkeywords.com/api/v1/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"primaryDomain\": \"example.com\",\n \"languageCode\": \"<string>\",\n \"locationCode\": 123,\n \"competitorDomains\": [\n \"competitor.com\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"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"
]
}
'import requests
url = "https://www.suprkeywords.com/api/v1/jobs"
payload = {
"primaryDomain": "example.com",
"languageCode": "<string>",
"locationCode": 123,
"competitorDomains": ["competitor.com"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
primaryDomain: 'example.com',
languageCode: '<string>',
locationCode: 123,
competitorDomains: ['competitor.com']
})
};
fetch('https://www.suprkeywords.com/api/v1/jobs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://www.suprkeywords.com/api/v1/jobs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'primaryDomain' => 'example.com',
'languageCode' => '<string>',
'locationCode' => 123,
'competitorDomains' => [
'competitor.com'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://www.suprkeywords.com/api/v1/jobs"
payload := strings.NewReader("{\n \"primaryDomain\": \"example.com\",\n \"languageCode\": \"<string>\",\n \"locationCode\": 123,\n \"competitorDomains\": [\n \"competitor.com\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://www.suprkeywords.com/api/v1/jobs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"primaryDomain\": \"example.com\",\n \"languageCode\": \"<string>\",\n \"locationCode\": 123,\n \"competitorDomains\": [\n \"competitor.com\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://www.suprkeywords.com/api/v1/jobs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"primaryDomain\": \"example.com\",\n \"languageCode\": \"<string>\",\n \"locationCode\": 123,\n \"competitorDomains\": [\n \"competitor.com\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}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