https://api.nexscope.ai/ai/patentPdfDownloadRun this API
Send a JSON request to execute this API and receive the documented response payload.
Endpoint
| Method | POST |
| Path | https://api.nexscope.ai/ai/patentPdfDownload |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
patentId | string | conditional | Comma-separated patent IDs, up to 100; takes precedence over patentNumber. |
patentNumber | string | conditional | Comma-separated publication numbers, up to 100. Example: US10123456B2 |
replaceByRelated | string | optional | Use a related family patent if the requested PDF is unavailable: string 1 for yes, 0 for no. Example: 0 |
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"columns": [],
"data": [
{
"patentId": "patent-id",
"pdfPath": "https://example.com/patent.pdf",
"pn": "US20230012345A1"
}
],
"total": 1
},
"msg": null,
"time": "2026-01-01 00:00:00",
"traceId": null,
"ts": "0"
}Response fields
| Name | Type | Required | Description |
|---|---|---|---|
code | integer | required | 0 means accepted or successful; nonzero is a platform error. |
cost | string | required | Elapsed milliseconds, never credits; -1 outside web requests. |
data | any | required | Data value used by this API operation. |
msg | string | null | required | Msg value used by this API operation. |
time | string | required | Server local time: yyyy-MM-dd HH:mm:ss. |
traceId | string | null | required | Trace id value used by this API operation. |
ts | string | required | Epoch milliseconds. |
data: object · variant 1 15 fields
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data value used by this API operation. |
data.columns | any | optional | Columns value used by this API operation. |
data.costTime | any | optional | Cost time value used by this API operation. |
data.costToken | any | optional | Cost token value used by this API operation. |
data.data | any | optional | Data value used by this API operation. |
data.dataSnapshotMonth | any | optional | Data snapshot month value used by this API operation. |
data.page | any | optional | Page value used by this API operation. |
data.pageItemCount | any | optional | Page item count value used by this API operation. |
data.pageSize | any | optional | Page size value used by this API operation. |
data.sourceTool | any | optional | Source tool value used by this API operation. |
data.sourceType | any | optional | Source type value used by this API operation. |
data.title | any | optional | Title value used by this API operation. |
data.total | any | optional | Total value used by this API operation. |
data.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.columns: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | array | optional | Source rendering columns. Example: [] |
data.columns: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.columns | null | optional | Columns value used by this API operation. |
data.costTime: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | integer | optional | Execution time reported by the upstream provider. Example: null |
data.costTime: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.costTime | null | optional | Cost time value used by this API operation. |
data.costToken: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | integer | optional | Provider-reported token cost; Nexscope billing follows its own price configuration. Example: null |
data.costToken: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.costToken | null | optional | Cost token value used by this API operation. |
data.data: array · variant 1 6 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data | array | optional | Patent PDF records. Example: [] |
data.data[] | object | required | Item in data data. |
data.data[].patentId | string | optional | Patent ID. Example: patent-id |
data.data[].pdfPath | string | optional | Source PDF download link or path. Example: https://example.com/patent.pdf |
data.data[].pn | string | optional | Publication number. Example: US10123456B2 |
data.data[].pnRelated | string | optional | Related publication used as a substitute, if any. Example: null |
data.data: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data | null | optional | Data value used by this API operation. |
data.dataSnapshotMonth: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | string | optional | Data snapshot month returned by the upstream provider. Example: null |
data.dataSnapshotMonth: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.dataSnapshotMonth | null | optional | Data snapshot month value used by this API operation. |
data.page: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.page | integer | optional | Current page returned by the upstream provider. Example: null |
data.page: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.page | null | optional | Page value used by this API operation. |
data.pageItemCount: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | integer | optional | Item count on the current page returned by the upstream provider. Example: null |
data.pageItemCount: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.pageItemCount | null | optional | Page item count value used by this API operation. |
data.pageSize: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | integer | optional | Page size returned by the upstream provider. Example: null |
data.pageSize: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.pageSize | null | optional | Page size value used by this API operation. |
data.sourceTool: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | string | optional | Provider-specific source tool name. Example: null |
data.sourceTool: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceTool | null | optional | Source tool value used by this API operation. |
data.sourceType: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | string | optional | Provider-specific source platform type. Example: null |
data.sourceType: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.sourceType | null | optional | Source type value used by this API operation. |
data.title: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.title | string | optional | Provider-specific response title. Example: null |
data.title: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.title | null | optional | Title value used by this API operation. |
data.total: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.total | integer | optional | Number of returned records. Example: 1 |
data.total: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.total | null | optional | Total value used by this API operation. |
data.totalPage: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | integer | optional | Total page count returned by the upstream provider. Example: null |
data.totalPage: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.totalPage | null | optional | Total page value used by this API operation. |
data.type: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.type | string | optional | Source rendering style. Example: null |
data.type: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.type | null | optional | Type value used by this API operation. |
data: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data | null | required | Data value used by this API operation. |
Responses
| Code | Description |
|---|---|
| 200 | Default HTTP response for both success and many business errors. Only outer JSON code 0 indicates success or asynchronous acceptance; inspect data for the result. |
| 429 | Execution admission rate limit; honor Retry-After when present. |
| 503 | Execution admission is temporarily unavailable; honor Retry-After when present. |
| Opt-in | X-Nexscope-Http-Status: semantic maps controller-handled business errors to HTTP status on run and task routes. Pre-authentication failures, such as a missing or invalid API key (code 11209, including an incomplete or corrupted copy) or an expired website login session (code 12001), may still return HTTP 200 before this mapping. Always check the outer JSON code; malformed requests and infrastructure failures may also return non-200 HTTP responses. |
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.