/api/skill-api/v1/skills/seo-keyword-expand/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | /api/skill-api/v1/skills/seo-keyword-expand/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
keyword | string | required | Trimmed, at most ten whitespace-separated words. Minimum length: 1 Maximum length: 80 |
language | string | required | Language value used by this API operation. Allowed: en |
limit | integer | optional | Limit value used by this API operation. Default: 10 Minimum: 1 Maximum: 20 |
market | string | required | Market value used by this API operation. Allowed: US |
sources | array | optional | Sources value used by this API operation. Default: ["suggestions","related"] Minimum items: 1 Maximum items: 2 |
sources[] | string | required | Item in sources. Allowed: suggestions, related |
Request example
{
"keyword": "nexscope",
"language": "en",
"limit": 10,
"market": "US",
"sources": [
"suggestions",
"related"
]
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. Allowed: 0, 42008, 42009 |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | optional | Call id value used by this API operation. Format: uuid |
data.completedAt | string | integer | null | optional | UTC epoch milliseconds. |
data.coverage | object | optional | Coverage value used by this API operation. |
data.coverage.missing | array | optional | Missing value used by this API operation. |
data.coverage.missing[] | object | required | Item in data coverage missing. |
data.coverage.missing[].field | string | optional | Field value used by this API operation. |
data.coverage.missing[].reason | string | optional | Reason value used by this API operation. |
data.coverage.status | string | optional | Status value used by this API operation. |
data.reason | string | optional | Stable reason on errors 42001 through 42011; accepted errors retain callId. |
data.requestedAt | string | integer | null | optional | UTC epoch milliseconds. |
data.result | object | null | required | Result value used by this API operation. |
data.result.items | array | optional | Items value used by this API operation. |
data.result.items[] | object | required | Item in data result items. |
data.result.items[].keyword | string | null | optional | Keyword value used by this API operation. |
data.result.items[].keywordDifficulty | number | null | optional | Keyword difficulty value used by this API operation. |
data.result.items[].missing | array | optional | Missing value used by this API operation. |
data.result.items[].missing[] | object | required | Item in data result items[] missing. |
data.result.items[].missing[].field | string | null | optional | Field value used by this API operation. |
data.result.items[].missing[].reason | string | null | optional | Reason value used by this API operation. |
data.result.items[].relations | array | optional | Relations value used by this API operation. |
data.result.items[].relations[] | object | required | Item in data result items[] relations. |
data.result.items[].relations[].depth | integer | null | optional | Depth value used by this API operation. |
data.result.items[].relations[].seed | string | null | optional | Seed value used by this API operation. |
data.result.items[].relations[].source | string | null | optional | Source value used by this API operation. |
data.result.items[].searchVolume | integer | null | optional | Search volume value used by this API operation. |
data.result.language | string | null | optional | Language value used by this API operation. |
data.result.market | string | null | optional | Market value used by this API operation. |
data.result.requestedLimit | integer | null | optional | Requested limit value used by this API operation. |
data.result.returnedCount | integer | null | optional | Returned count value used by this API operation. |
data.result.seed | string | null | optional | Seed value used by this API operation. |
data.result.sources | array | optional | Sources value used by this API operation. |
data.result.sources[] | object | required | Item in data result sources. |
data.result.sources[].missingReason | string | null | optional | Missing reason value used by this API operation. |
data.result.sources[].returnedCount | integer | null | optional | Returned count value used by this API operation. |
data.result.sources[].source | string | null | optional | Source value used by this API operation. |
data.result.sources[].status | string | null | optional | Status value used by this API operation. |
data.retryable | boolean | optional | Retryable value used by this API operation. Constant: false |
data.schemaVersion | string | optional | Schema version value used by this API operation. Constant: 1.0 |
data.source | string | optional | Source value used by this API operation. Constant: dataforseo |
data.status | string | optional | Status value used by this API operation. Allowed: SUCCESS, PARTIAL, EMPTY, PROCESSING, UNKNOWN, FAILED |
data.usage | object | null | optional | Usage value used by this API operation. |
data.usage.billingStatus | string | null | optional | Billing status value used by this API operation. |
data.usage.chargedCredits | string | integer | null | optional | Charged credits value used by this API operation. |
msg | string | null | required | Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Accepted processing response
code 0 confirms acceptance. Use data.callId to query the same request; processing is not completion.
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. Constant: 0 |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | null | required | Call id value used by this API operation. |
data.reason | string | required | Reason value used by this API operation. Constant: IN_PROGRESS |
data.retryable | boolean | optional | Retryable value used by this API operation. |
data.status | string | required | Status value used by this API operation. Constant: PROCESSING |
data.taskId | string | null | optional | Task id value used by this API operation. |
msg | string | null | required | Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Error response
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 is a successful envelope; inspect data.status separately. |
cost | string | required | Elapsed processing milliseconds; not price. -1 for non-web context. |
data | object | required | Data value used by this API operation. |
data.callId | string | null | required | Call id value used by this API operation. |
data.reason | string | null | required | Reason value used by this API operation. |
data.retryable | boolean | optional | Retryable value used by this API operation. |
data.status | string | null | required | Status value used by this API operation. |
data.taskId | string | null | optional | Task id value used by this API operation. |
msg | string | null | required | Available upstream msg/errmsg/message is preferred for success and failure; Chinese is translated to English. Missing successful message is null. Platform-only errors and task states use platform English. Message text never determines success or retry. |
time | string | required | yyyy-MM-dd HH:mm:ss |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds; global long serializer. |
Response example
Example response envelope from the documented SEO API contract.
{
"code": 0,
"cost": "-1",
"data": {
"callId": "synthetic-call",
"completedAt": null,
"coverage": {
"missing": [
{
"field": "synthetic",
"reason": "UPSTREAM_FIELD_MISSING"
}
],
"status": "PARTIAL"
},
"requestedAt": "123",
"result": {
"items": [
{
"keyword": "synthetic",
"keywordDifficulty": 9007199254740992,
"missing": [
{
"field": "synthetic",
"reason": "synthetic"
}
],
"relations": [
{
"depth": 1,
"seed": "synthetic",
"source": "synthetic"
}
],
"searchVolume": 9007199254740992
}
],
"language": "synthetic",
"market": "synthetic",
"requestedLimit": 1,
"returnedCount": 1,
"seed": "synthetic",
"sources": [
{
"missingReason": "synthetic",
"returnedCount": 1,
"source": "synthetic",
"status": "synthetic"
}
]
},
"schemaVersion": "synthetic",
"source": "synthetic",
"status": "PARTIAL",
"usage": {
"billingStatus": "UNAPPROVED",
"chargedCredits": "0"
}
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": "synthetic-trace",
"ts": "9007199254740993"
}Retrieve a processing result
A response with PROCESSING and a callId means the result is still being prepared. Use the result query below with the returned identifier. This lookup reads the stored result and does not spend credits.
curl -X GET https://api.nexscope.ai/api/skill-api/v1/skills/seo-keyword-expand/calls/{callId} \
-H "Authorization: Bearer nk-xxxxxxxxxxxxxxxxx"Responses
| Code | Description |
|---|---|
| 200 | HTTP request completed. Check JSON code; only 0 indicates business success or acceptance. |
| 400 | Request JSON or required API parameters are invalid. |
| 401 | API key is missing, invalid, or cannot be matched to a user. |
| 5xx | API execution or upstream service failed. |
Data source, freshness, and limitations
Source, freshness, coverage, rate limits, and estimation notes are not specified in this API definition unless they appear in the request or response field documentation above. Do not assume official marketplace data or real-time freshness when it is not explicitly documented.