https://api.nexscope.ai/ai/designSimilaritySearchRun 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/designSimilaritySearch |
| Auth | Bearer API key |
| Content-Type | application/json |
Request parameters
| Name | Type | Required | Description |
|---|---|---|---|
imageBase64 | string | optional | Pure Base64 image bytes, 16–20971520 characters; omit imageUrl. Pattern: ^[A-Za-z0-9+/]+={0,2}$ Minimum length: 16 Maximum length: 20971520 |
imageUrl | string | optional | Public HTTP(S) image URL, 8–4096 characters; exactly one image source. Format: uri Pattern: ^https?:// Minimum length: 8 Maximum length: 4096 |
jurisdictionCodes | array | optional | Up to 32 distinct source codes of 2–8 letters; intersects regions when both are supplied. Maximum items: 32 |
jurisdictionCodes[] | string | required | Up to 32 distinct source codes of 2–8 letters; intersects regions when both are supplied. Pattern: ^[A-Za-z]{2,8}$ |
locarnoClasses | array | optional | Up to 64 distinct NN-NN Locarno classes. Maximum items: 64 |
locarnoClasses[] | string | required | Up to 64 distinct NN-NN Locarno classes. Pattern: ^[0-9]{2}-[0-9]{2}$ |
patentStatus | array | optional | One or two distinct integers: 0 inactive, 1 active; omit for no status preference. Minimum items: 1 Maximum items: 2 |
patentStatus[] | integer | required | One or two distinct integers: 0 inactive, 1 active; omit for no status preference. Allowed: 0, 1 |
regions | array | optional | Up to 64 distinct two-letter region codes, e.g. US or EM; use EM for EU. Maximum items: 64 |
regions[] | string | required | Up to 64 distinct two-letter region codes, e.g. US or EM; use EM for EU. Pattern: ^[A-Za-z]{2}$ |
title | string | optional | Optional image context, 1–4096 trimmed characters; not a standalone text query. Minimum length: 1 Maximum length: 4096 |
topK | integer | optional | Candidate limit, 1–200; default 20. Default: 20 Minimum: 1 Maximum: 200 |
topLoc | array | optional | Up to 32 distinct two-digit Locarno prefixes; preserve leading zeros. Maximum items: 32 |
topLoc[] | string | required | Up to 32 distinct two-digit Locarno prefixes; preserve leading zeros. Pattern: ^[0-9]{2}$ |
One of option 1 — requires imageUrl
One of option 2 — requires imageBase64
Response example
Platform response envelope. code 0 indicates success or acceptance; data contains the business result.
{
"code": 0,
"cost": "-1",
"data": {
"data": {
"code": "OK",
"data": {
"candidates": [
{
"applicant_addresses": null,
"application_date": "2010-04-13",
"application_number": "001694860",
"design_registration_id": "DSR:euipo_design:001694860-0001",
"designer_names": null,
"estimated_expiration_date": null,
"expiration_date_basis": null,
"holder_names": [
"237302"
],
"image_url": "https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000",
"images": [
"https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000",
"https://example.com/design-2.png?signature=second&expires=2000000000"
],
"jurisdiction_iso2": "EM",
"locarno_classes": [
"06.01"
],
"locarno_details": [
{
"code": "06.01",
"label_en": null,
"label_zh": null,
"parent_code": "06"
}
],
"novelty_statement": null,
"primary_identifier": "001694860-0001",
"protected_jurisdictions": [
"EM"
],
"publication_date": null,
"publication_number": null,
"registration_date": null,
"registration_jurisdiction_code": "EU",
"registration_number": "E077151-PC",
"risk_level": "medium",
"similarity": 99.88,
"simple_legal_status": "inactive",
"specification": null,
"title": "E077151-PC",
"title_en": "Chairs [seats]",
"title_language": "unknown",
"tro_cases": []
}
],
"total": 1
},
"message": "success",
"request_id": "req_example"
}
},
"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 — requires data 54 fields
| Name | Type | Required | Description |
|---|---|---|---|
data | object | required | Data 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 | object | required | Source envelope inside the gateway payload. Example: {} |
data.data.code | string | required | Success is OK. Errors include 400 DATA_IMAGE_DOWNLOAD_FAILED (no image substitution), 413 SYSTEM_PAYLOAD_TOO_LARGE (no automatic compression), 502 SR_QUERY_ERROR and 503 CAPABILITY_BACKEND_UNAVAILABLE (backend failure, not zero hits or insufficient credits). Preserve actual code and request identifiers; no automatic retries. Example: OK |
data.data.data | object | required | Search result; preserve optional coverage and warnings when returned. Example: {} |
data.data.data.candidates | array | required | Candidates in returned order; empty is not freedom to operate. Example: [{"applicant_addresses":null,"application_date":"2010-04-13","application_number":"001694860","design_registration_id":"DSR:euipo_design:001694860-0001","designer_names":null,"estimated_expiration_date":null,"expiration_date_basis":null,"holder_names":["237302"],"image_url":"https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000","images":["https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000","https://example.com/design-2.png?signature=second&expires=2000000000"],"jurisdiction_iso2":"EM","locarno_classes":["06.01"],"locarno_details":[{"code":"06.01","label_en":null,"label_zh":null,"parent_code":"06"}],"novelty_statement":null,"primary_identifier":"001694860-0001","protected_jurisdictions":["EM"],"publication_date":null,"publication_number":null,"registration_date":null,"registration_jurisdiction_code":"EU","registration_number":"E077151-PC","risk_level":"medium","similarity":99.88,"simple_legal_status":"inactive","specification":null,"title":"E077151-PC","title_en":"Chairs [seats]","title_language":"unknown","tro_cases":[]}] |
data.data.data.candidates[] | object | required | Item in data data data candidates. |
data.data.data.candidates[].applicant_addresses | any | optional | Applicant addresses value used by this API operation. |
data.data.data.candidates[].application_date | any | optional | Application date value used by this API operation. |
data.data.data.candidates[].application_number | any | optional | Application number value used by this API operation. |
data.data.data.candidates[].design_registration_id | any | optional | Design registration id value used by this API operation. |
data.data.data.candidates[].designer_names | any | optional | Designer names value used by this API operation. |
data.data.data.candidates[].estimated_expiration_date | any | optional | Estimated expiration date value used by this API operation. |
data.data.data.candidates[].expiration_date_basis | any | optional | Expiration date basis value used by this API operation. |
data.data.data.candidates[].holder_names | any | optional | Holder names value used by this API operation. |
data.data.data.candidates[].image_url | any | optional | Image url value used by this API operation. |
data.data.data.candidates[].images | any | optional | Images value used by this API operation. |
data.data.data.candidates[].jurisdiction_iso2 | any | optional | Jurisdiction iso2 value used by this API operation. |
data.data.data.candidates[].locarno_classes | any | optional | Locarno classes value used by this API operation. |
data.data.data.candidates[].locarno_details | any | optional | Locarno details value used by this API operation. |
data.data.data.candidates[].novelty_statement | any | optional | Novelty statement value used by this API operation. |
data.data.data.candidates[].primary_identifier | any | optional | Primary identifier value used by this API operation. |
data.data.data.candidates[].protected_jurisdictions | any | optional | Protected jurisdictions value used by this API operation. |
data.data.data.candidates[].publication_date | any | optional | Publication date value used by this API operation. |
data.data.data.candidates[].publication_number | any | optional | Publication number value used by this API operation. |
data.data.data.candidates[].registration_date | any | optional | Registration date value used by this API operation. |
data.data.data.candidates[].registration_jurisdiction_code | any | optional | Registration jurisdiction code value used by this API operation. |
data.data.data.candidates[].registration_number | any | optional | Registration number value used by this API operation. |
data.data.data.candidates[].risk_level | any | optional | Risk level value used by this API operation. |
data.data.data.candidates[].similarity | any | optional | Similarity value used by this API operation. |
data.data.data.candidates[].simple_legal_status | any | optional | Simple legal status value used by this API operation. |
data.data.data.candidates[].specification | any | optional | Specification value used by this API operation. |
data.data.data.candidates[].title | any | optional | Title value used by this API operation. |
data.data.data.candidates[].title_en | any | optional | Title en value used by this API operation. |
data.data.data.candidates[].title_language | any | optional | Title language value used by this API operation. |
data.data.data.candidates[].tro_cases | any | optional | Tro cases value used by this API operation. |
data.data.data.coverage | any | optional | Coverage value used by this API operation. |
data.data.data.total | any | optional | Total value used by this API operation. |
data.data.data.warnings | any | optional | Warnings value used by this API operation. |
data.data.message | any | optional | Message value used by this API operation. |
data.data.request_id | any | optional | Request id value used by this API operation. |
data.data.usage | any | optional | Usage 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.requestId | any | optional | Request id 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.totalPage | any | optional | Total page value used by this API operation. |
data.type | any | optional | Type value used by this API operation. |
data.upstreamRequestId | any | optional | Upstream request id 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 | Token cost reported by the upstream provider. 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.data.candidates[].applicant_addresses: array · variant 1 4 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].applicant_addresses | array | optional | Source applicant objects with name and address; never infer protection jurisdictions. Example: null |
data.data.data.candidates[].applicant_addresses[] | object | required | Item in data data data candidates[] applicant_addresses. |
data.data.data.candidates[].applicant_addresses[].address | string | optional | Source address; not evidence of protected jurisdiction. Example: Example address |
data.data.data.candidates[].applicant_addresses[].name | string | optional | Source applicant name. Example: Example applicant |
data.data.data.candidates[].applicant_addresses: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].applicant_addresses | null | optional | Applicant addresses value used by this API operation. |
data.data.data.candidates[].application_date: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].application_date | string | optional | Source application date, YYYY-MM-DD. Example: 2010-04-13 |
data.data.data.candidates[].application_date: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].application_date | null | optional | Application date value used by this API operation. |
data.data.data.candidates[].application_number: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].application_number | string | optional | Source application number. Example: 001694860 |
data.data.data.candidates[].application_number: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].application_number | null | optional | Application number value used by this API operation. |
data.data.data.candidates[].design_registration_id: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].design_registration_id | string | optional | Exact registration ID for details; preserve unchanged. Example: DSR:euipo_design:001694860-0001 |
data.data.data.candidates[].design_registration_id: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].design_registration_id | null | optional | Design registration id value used by this API operation. |
data.data.data.candidates[].designer_names: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].designer_names | array | optional | Source designers; missing or null means unknown. Example: null |
data.data.data.candidates[].designer_names: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].designer_names | null | optional | Designer names value used by this API operation. |
data.data.data.candidates[].estimated_expiration_date: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].estimated_expiration_date | string | optional | Estimated date only, YYYY-MM-DD; not confirmed expiry or invalidity. Example: null |
data.data.data.candidates[].estimated_expiration_date: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].estimated_expiration_date | null | optional | Estimated expiration date value used by this API operation. |
data.data.data.candidates[].expiration_date_basis: object | array | string | number | boolean | null · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].expiration_date_basis | object | array | string | number | boolean | null | optional | Source JSON of any shape, or null; never invent an estimation basis. Example: null |
data.data.data.candidates[].expiration_date_basis: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].expiration_date_basis | null | optional | Expiration date basis value used by this API operation. |
data.data.data.candidates[].holder_names: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].holder_names | array | optional | Source holders; do not resolve numeric identifiers to invented names. Example: ["237302"] |
data.data.data.candidates[].holder_names: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].holder_names | null | optional | Holder names value used by this API operation. |
data.data.data.candidates[].image_url: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].image_url | string | optional | Complete signed first-image URL; when images exist this equals images[0]. Never strip query parameters. Example: https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000 |
data.data.data.candidates[].image_url: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].image_url | null | optional | Image url value used by this API operation. |
data.data.data.candidates[].images: array · variant 1 2 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].images | array | optional | At most six complete signed image URLs in original order; empty means no available images. Example: ["https://example.com/design-1.png?signature=example%2Bsignature&expires=2000000000","https://example.com/design-2.png?signature=second&expires=2000000000"] Maximum items: 6 |
data.data.data.candidates[].images[] | string | required | Item in data data data candidates[] images. |
data.data.data.candidates[].images: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].images | null | optional | Images value used by this API operation. |
data.data.data.candidates[].jurisdiction_iso2: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].jurisdiction_iso2 | string | optional | Registration jurisdiction, distinct from protected jurisdictions. Example: EM |
data.data.data.candidates[].jurisdiction_iso2: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].jurisdiction_iso2 | null | optional | Jurisdiction iso2 value used by this API operation. |
data.data.data.candidates[].locarno_classes: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].locarno_classes | array | optional | Preserve output codes such as 06.01 or 09-01; requests still require NN-NN. Example: ["06.01"] |
data.data.data.candidates[].locarno_classes: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].locarno_classes | null | optional | Locarno classes value used by this API operation. |
data.data.data.candidates[].locarno_details: array · variant 1 6 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].locarno_details | array | optional | Source code, parent_code, label_zh and label_en; missing labels stay unknown. Example: [{"code":"06.01","label_en":null,"label_zh":null,"parent_code":"06"}] |
data.data.data.candidates[].locarno_details[] | object | required | Item in data data data candidates[] locarno_details. |
data.data.data.candidates[].locarno_details[].code | string | optional | Unmodified source classification code. Example: 06.01 |
data.data.data.candidates[].locarno_details[].label_en | string | optional | Source English label; missing/null stays unknown. Example: null |
data.data.data.candidates[].locarno_details[].label_zh | string | optional | Source Chinese label; missing/null stays unknown. Example: null |
data.data.data.candidates[].locarno_details[].parent_code | string | optional | Source parent classification. Example: 06 |
data.data.data.candidates[].locarno_details: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].locarno_details | null | optional | Locarno details value used by this API operation. |
data.data.data.candidates[].novelty_statement: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].novelty_statement | string | optional | Source novelty statement; retain original text, not a legal conclusion. Example: null |
data.data.data.candidates[].novelty_statement: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].novelty_statement | null | optional | Novelty statement value used by this API operation. |
data.data.data.candidates[].primary_identifier: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].primary_identifier | string | optional | Primary display number; retain leading zeros. Example: 001694860-0001 |
data.data.data.candidates[].primary_identifier: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].primary_identifier | null | optional | Primary identifier value used by this API operation. |
data.data.data.candidates[].protected_jurisdictions: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].protected_jurisdictions | array | optional | HAGUE designated states or ordinary registration jurisdiction; null means unknown, never fill from regions. Example: ["EM"] |
data.data.data.candidates[].protected_jurisdictions: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].protected_jurisdictions | null | optional | Protected jurisdictions value used by this API operation. |
data.data.data.candidates[].publication_date: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].publication_date | string | optional | Source publication date, YYYY-MM-DD. Example: null |
data.data.data.candidates[].publication_date: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].publication_date | null | optional | Publication date value used by this API operation. |
data.data.data.candidates[].publication_number: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].publication_number | string | optional | Source publication number; missing or null means unknown. Example: null |
data.data.data.candidates[].publication_number: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].publication_number | null | optional | Publication number value used by this API operation. |
data.data.data.candidates[].registration_date: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].registration_date | string | optional | Source registration date, YYYY-MM-DD. Example: null |
data.data.data.candidates[].registration_date: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].registration_date | null | optional | Registration date value used by this API operation. |
data.data.data.candidates[].registration_jurisdiction_code: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].registration_jurisdiction_code | string | optional | Source jurisdiction code such as EU, EMID or USID; do not rewrite as ISO-2. Example: EU |
data.data.data.candidates[].registration_jurisdiction_code: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].registration_jurisdiction_code | null | optional | Registration jurisdiction code value used by this API operation. |
data.data.data.candidates[].registration_number: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].registration_number | string | optional | Source registration number. Example: E077151-PC |
data.data.data.candidates[].registration_number: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].registration_number | null | optional | Registration number value used by this API operation. |
data.data.data.candidates[].risk_level: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].risk_level | string | optional | Source risk hint, separate from score and legal status; not an infringement verdict. Example: medium |
data.data.data.candidates[].risk_level: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].risk_level | null | optional | Risk level value used by this API operation. |
data.data.data.candidates[].similarity: number · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].similarity | number | optional | Final 0-100 score, not a probability. Preserve returned order; never multiply by 100 or sort again. Example: 99.88 Minimum: 0 Maximum: 100 |
data.data.data.candidates[].similarity: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].similarity | null | optional | Similarity value used by this API operation. |
data.data.data.candidates[].simple_legal_status: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].simple_legal_status | string | optional | Source legal status; do not infer it from similarity. Example: inactive |
data.data.data.candidates[].simple_legal_status: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].simple_legal_status | null | optional | Simple legal status value used by this API operation. |
data.data.data.candidates[].specification: object | array | string | number | boolean | null · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].specification | object | array | string | number | boolean | null | optional | Source JSON of any shape, or null; preserve actual structure without filling gaps. Example: null |
data.data.data.candidates[].specification: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].specification | null | optional | Specification value used by this API operation. |
data.data.data.candidates[].title: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].title | string | optional | Source title, which may be a number. Example: E077151-PC |
data.data.data.candidates[].title: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].title | null | optional | Title value used by this API operation. |
data.data.data.candidates[].title_en: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].title_en | string | optional | Source English title; do not translate missing values. Example: Chairs [seats] |
data.data.data.candidates[].title_en: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].title_en | null | optional | Title en value used by this API operation. |
data.data.data.candidates[].title_language: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].title_language | string | optional | Source title language; may be unknown. Example: unknown |
data.data.data.candidates[].title_language: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].title_language | null | optional | Title language value used by this API operation. |
data.data.data.candidates[].tro_cases: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].tro_cases | array | optional | Current TRO corpus associations; empty is not confirmation of no TRO. Example: [] |
data.data.data.candidates[].tro_cases: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.candidates[].tro_cases | null | optional | Tro cases value used by this API operation. |
data.data.data.coverage: object · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.coverage | object | optional | Optional source coverage; do not infer completeness. Example: {} |
data.data.data.coverage: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.coverage | null | optional | Coverage value used by this API operation. |
data.data.data.total: integer · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.total | integer | optional | Returned candidate count, not corpus size or user billing units. Example: 1 |
data.data.data.total: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.total | null | optional | Total value used by this API operation. |
data.data.data.warnings: array · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.warnings | array | optional | Optional source limitations. Example: [] |
data.data.data.warnings: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.data.warnings | null | optional | Warnings value used by this API operation. |
data.data.message: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.message | string | optional | Source status message. Example: success |
data.data.message: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.message | null | optional | Message value used by this API operation. |
data.data.request_id: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.request_id | string | optional | Upstream request identifier; keep separate from requestId. Example: req_example |
data.data.request_id: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.request_id | null | optional | Request id value used by this API operation. |
data.data.usage: object · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.usage | object | optional | Source-account usage; not user debit or balance. Example: {} |
data.data.usage: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.data.usage | null | optional | Usage 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.requestId: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.requestId | string | optional | Gateway/service error request identifier; distinct from upstream request_id. Example: gateway_example |
data.requestId: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.requestId | null | optional | Request id 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.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 | Provider-specific render or payload type. 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.upstreamRequestId: string · variant 1 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.upstreamRequestId | string | optional | Extracted upstream request identifier. Example: req_example |
data.upstreamRequestId: null · variant 2 1 fields
| Name | Type | Required | Description |
|---|---|---|---|
data.upstreamRequestId | null | optional | Upstream request id 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.