POST
https://api.nexscope.ai/api/skill-api/v1/skills/text-trademark-detector/runRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/api/skill-api/v1/skills/text-trademark-detector/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
productTitle | string | required | Product title, used for trademark detection (max 1000 characters) Example: MagSafe Phone Case for iPhone |
regions | string | optional | Country/region codes, multiple separated by commas. Available options
Example: US |
limit | integer | required | Limit on the number of returned results (default 100, max 500) Example: 10 |
productText | string | optional | Other product text information, such as bullet points or product description (max 1000 characters) Example: Protective magnetic phone case with shockproof corners. |
Request example
{
"productTitle": "MagSafe Phone Case for iPhone",
"limit": 10,
"productText": "Protective magnetic phone case with shockproof corners.",
"regions": "US"
}Response body
| Name | Type | Required | Description |
|---|---|---|---|
data | any | required | Data value used by this API operation. |
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
msg | string | null | required | Msg value used by this API operation. |
ts | string | required | Epoch milliseconds. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
traceId | string | null | required | Trace id value used by this API operation. |
Any of option 1
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.total | integer | optional | Number of matched trademark records Example: 1 |
data.data | array | optional | Trademark list (flattened), each element contains the following fields Example: [] |
data.detectId | string | optional | API call ID Example: example-id |
data.columns | array | optional | Rendered column definitions Example: [] |
data.blacklistTrademarks | array | optional | Blacklisted trademarks detected in the text Example: [] |
data.whitelistTrademarks | array | optional | Whitelisted (safe) trademarks detected in the text Example: [] |
data.data[].textTrademarkRadar | string | optional | Product risk level: "0" = low risk, "1" = pending manual review, "2" = high risk Example: null |
data.costToken | integer | optional | Token cost Example: 1 |
data.type | string | optional | Render style Example: null |
data.data[].trademarkName | string | optional | Trademark word Example: null |
data.data[].region | string | optional | Country/region code Example: US |
data.data[].score | integer | optional | Risk score Example: 1 |
data.data[].highestModeScore | integer | optional | Highest risk score (range 0-5) Example: 1 |
data.data[].trademarksStatus | string | optional | Status of the highest-score trademark word Example: null |
data.data[].regionStatus | string | optional | Trademark status in the matched region Example: null |
data.data[].holder | string | optional | Rights holder Example: null |
data.data[].applicationNumber | string | optional | Application number Example: null |
data.data[].registrationNumber | string | optional | Registration number Example: null |
data.data[].isFamous | boolean | optional | Whether it is a famous trademark Example: false |
data.data[].isAmazonBrand | boolean | optional | Whether it is an Amazon hot search brand Example: false |
data.data[].isActiveHolder | boolean | optional | Whether the holder is an active enforcer Example: false |
data.data[].isCompatibility | boolean | optional | Whether it is compatibility Example: false |
data.data[].isCommonSense | boolean | optional | Whether it is a common word Example: false |
data.data[].niceClass | array | optional | Nice classification Example: [] |
data.data[].originalTextMatches | array | optional | Original matched trigger words Example: [] |
data.blacklisttrademarks[].trademark | string | optional | Trademark name Example: null |
data.blacklisttrademarks[].region | string | optional | Country/region code Example: US |
data.blacklisttrademarks[].note | string | optional | Remarks Example: null |
data.title | string | optional | Provider-specific response title. Example: null |
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
Any of option 2
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"data": {
"total": 1,
"data": [
{
"region": "US",
"score": 1,
"highestModeScore": 1,
"isFamous": false,
"isAmazonBrand": false,
"isActiveHolder": false,
"isCompatibility": false,
"isCommonSense": false,
"niceClass": [],
"originalTextMatches": []
}
],
"detectId": "example-id",
"columns": [],
"blacklistTrademarks": [],
"whitelistTrademarks": [],
"costToken": 1,
"blacklisttrademarks": [
{
"region": "US"
}
]
},
"code": 0,
"msg": null,
"ts": "0",
"time": "2026-01-01 00:00:00",
"cost": "-1",
"traceId": null
}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.