Keywords and GEO
Launch a keyword generation run
Starts the application’s full keyword generation for the site and
returns HTTP 202 with the run to follow with getKeywordRun; its
keywords are then read with listKeywords. The run spends the AI
credits listed as ai_credits.costs.keyword_run by getQuotas. One
run at a time per site: a second one answers keyword_run_active.
mode: fresh first moves the available keywords to the removed list.
Replaying the same idempotency key returns the same run.
POST
/
profiles
/
{profile_id}
/
keyword-runs
Error
A valid request URL is required to generate request examples{
"data": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}Authorizations
OAuth2PersonalAPIKey
Scopes
Headers
Path Parameters
Body
application/json
Options of the application's keyword generation; all are optional.
⌘I
Error
A valid request URL is required to generate request examples{
"data": {
"run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "pending",
"receipt": {
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "accepted",
"resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"meta": {
"request_id": "<string>",
"operation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}{
"error": {
"code": "insufficient_quota",
"message": "The current article generation quota is exhausted.",
"request_id": "33333333-3333-4333-8333-333333333333",
"retryable": false
}
}
