POST
https://api.nexscope.ai/api/skill-api/v1/skills/ruiguan-trademark-graphic-detection/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/ruiguan-trademark-graphic-detection/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
imageUrl | string | required | Product image URL or Base64-encoded image data (maximum 1,000 characters) Example: https://m.media-amazon.com/images/I/719mRAn2VrL._AC_SL1500_.jpg |
topNumber | integer | required | Maximum number of YOLO bounding boxes to return (default 5, maximum 100). The actual result count may be lower Example: 1 |
productTitle | string | optional | Product title used for context-aware detection (maximum 1,000 characters) |
trademarkName | string | optional | Possible graphic-logo name used to narrow the search (maximum 1,000 characters) |
regions | string | optional | Comma-separated country or region codes to inspect. Defaults to all regions. Available options
Example: US |
enableLocalizing | boolean | optional | Whether to enable image cropping (default false) Example: false |
enableRadar | boolean | optional | Whether to enable radar monitoring (default true) Example: false |
Request example
{
"enableRadar": false,
"regions": "US",
"imageUrl": "https://m.media-amazon.com/images/I/719mRAn2VrL._AC_SL1500_.jpg",
"topNumber": 10,
"enableLocalizing": false
}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.boundingBoxCount | integer | optional | Number of detection results Example: 1 |
data.data[].radarResult | string | optional | Radar detection result Example: null |
data.total | integer | optional | Number of records Example: 1 |
data.data | array | optional | Detection results; see the fields below Example: [] |
data.detectId | string | optional | Detection ID Example: example-id |
data.columns | array | optional | Column definitions used for rendering Example: [] |
data.costToken | integer | optional | Tokens consumed Example: 1 |
data.type | string | optional | Rendering style Example: null |
data.data[].image | string | optional | URL of the matched trademark image Example: https://example.com/image.jpg |
data.data[].boundingBox | string | optional | Comma-separated YOLO coordinates Example: null |
data.data[].subRadarResult | string | optional | Sub-radar detection result Example: null |
data.data[].applicationNumber | string | optional | Application number Example: null |
data.data[].niceClassName | string | optional | Comma-separated Nice Classification names Example: null |
data.data[].applicantName | string | optional | Comma-separated rights-holder names Example: null |
data.data[].tradeMarkStatus | string | optional | Trademark status. Values: "DEL", "ended", "registered", "act", "pend", "filed", or an empty string Example: null |
data.data[].niceClass | array | optional | Nice Classification details Example: [] |
data.data[].similarity | number | optional | Similarity score from 0 to 1; higher values indicate greater similarity Example: 1 |
data.data[].registrationNumber | string | optional | Registration number Example: null |
data.data[].registrationOfficeCode | string | optional | Trademark registration office Example: null |
data.data[].registrationDate | string | optional | Registration date Example: 2026-01-01 |
data.data[].bid | string | optional | Logo identifier Example: example-id |
data.data[].trademarkName | string | optional | Text trademark name found in the image Example: null |
data.data[].applicationDate | string | optional | Application date Example: 2026-01-01 |
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": {
"boundingBoxCount": 1,
"total": 1,
"data": [
{
"image": "https://example.com/image.jpg",
"niceClass": [],
"similarity": 1,
"registrationDate": "2026-01-01",
"bid": "example-id",
"applicationDate": "2026-01-01"
}
],
"detectId": "example-id",
"columns": [],
"costToken": 1
},
"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.