https://claw-callback.nexscope.ai/api/skill-api/v1/skills/patent-description-data/runRun this API
Send a JSON request to execute this API and receive the direct response payload.
Endpoint
| Method | POST |
| Path | https://claw-callback.nexscope.ai/api/skill-api/v1/skills/patent-description-data/run |
| Auth | Bearer API key |
| Content-Type | application/json |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
patentId | string | optional | Patent ID (at least one of patentId and patentNumber must be provided; if both are present, patentId takes priority). Only a single value is supported; multiple values separated by commas are not allowed. Max length: 60000 characters. |
patentNumber | string | optional | Publication/grant number (at least one of patentId and patentNumber must be provided; if both are present, patentId takes priority). Only a single value is supported; multiple values separated by commas are not allowed. Max length: 60000 characters. Example: US11299876B2 |
replaceByRelated | string | optional | Whether to substitute with a family patent's description when the current patent's description is unavailable: 1 Yes, 0 No. Max length: 1000 characters. |
Request example
{
"patentNumber": "US11299876B2"
}Response body
Returns the documented upstream API response directly without an additional wrapper.
| Name | Type | Required | Description |
|---|---|---|---|
total | integer | optional | Number of patent records returned Example: 1 |
data | array | optional | Patent list, each element contains description data Example: [] |
data[].patentId | string | optional | Patent ID Example: example-id |
data[].pn | string | optional | Publication (grant) number |
data[].pnRelated | string | optional | Publication number of the substitute patent (only provided when family patent substitution is used) |
data[].description | array | optional | Description content sections Example: [] |
columns | array | optional | Column definitions for rendering Example: [] |
costToken | integer | optional | Tokens consumed Example: 1 |
type | string | optional | Render style |
errcode | integer | optional | Upstream status code returned by the provider. |
errmsg | string | optional | Upstream status message returned by the provider. |
code | string | optional | Provider-specific status code. |
msg | string | optional | Provider-specific status message. |
message | string | optional | Provider-specific message. |
title | string | optional | Provider-specific response title. |
sourceType | string | optional | Provider-specific source platform type. |
sourceTool | string | optional | Provider-specific source tool name. |
costTime | integer | optional | Execution time reported by the upstream provider. |
page | integer | optional | Current page returned by the upstream provider. |
pageSize | integer | optional | Page size returned by the upstream provider. |
pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. |
totalPage | integer | optional | Total page count returned by the upstream provider. |
dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. |
Response example
Direct response payload. No extra wrapper is added.
{
"total": 1,
"data": [
{
"patentId": "example-id",
"description": []
}
],
"columns": [],
"costToken": 1
}Responses
| Code | Description |
|---|---|
| 200 | API executed successfully. Body is the direct response payload. |
| 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.