Design Registration Research

Design Similarity Search

Find similar design-registration candidates from a product image.

MCP tool name

nexscope_design_similarity_search

MCP endpoint

https://api.nexscope.ai/mcp

JSON-RPC method

tools/call

Authentication

Use OAuth 2.1 Authorization Code with PKCE and the mcp:tools scope. API keys remain supported as a compatibility option.

Authorization: Bearer nk-xxxxxxxxxxxxxxxxx

If authentication fails, ask the user to open API Access and copy a valid key.

Call this MCP tool

Initialize an MCP 2025-11-25 Streamable HTTP session at https://api.nexscope.ai/mcp, then use tools/call.

{
  "jsonrpc": "2.0",
  "id": "design-similarity-search-1",
  "method": "tools/call",
  "params": {
    "name": "nexscope_design_similarity_search",
    "arguments": {
      "imageUrl": "https://example.com/product.png",
      "title": "Bottle",
      "topK": 20
    }
  }
}

MCP 2025-11-25 · Streamable HTTP

Progress is delivered on the original POST SSE response. GET SSE carries notifications; reconnecting must query existing asynchronous work rather than submit again.

Arguments

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 fields

Treat structuredContent as the programmatic API response payload.

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.

Any of option 1 — requires data

Name	Type	Required	Description
`data`	`object`	required	Data value used by this API operation.
`data.costTime`	`any`	optional	Execution time reported by the upstream provider.
`data.costToken`	`any`	optional	Token cost reported by the upstream provider.
`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	Candidates in returned order; empty is not freedom to operate.
`data.data.data.candidates[].applicant_addresses`	`any`	optional	Source applicant objects with name and address; never infer protection jurisdictions.
`data.data.data.candidates[].application_date`	`any`	optional	Source application date, YYYY-MM-DD.
`data.data.data.candidates[].application_number`	`any`	optional	Source application number.
`data.data.data.candidates[].design_registration_id`	`any`	optional	Exact registration ID for details; preserve unchanged.
`data.data.data.candidates[].designer_names`	`any`	optional	Source designers; missing or null means unknown.
`data.data.data.candidates[].estimated_expiration_date`	`any`	optional	Estimated date only, YYYY-MM-DD; not confirmed expiry or invalidity.
`data.data.data.candidates[].expiration_date_basis`	`any`	optional	Source JSON of any shape, or null; never invent an estimation basis.
`data.data.data.candidates[].holder_names`	`any`	optional	Source holders; do not resolve numeric identifiers to invented names.
`data.data.data.candidates[].image_url`	`any`	optional	Complete signed first-image URL; when images exist this equals images[0]. Never strip query parameters.
`data.data.data.candidates[].images`	`any`	optional	At most six complete signed image URLs in original order; empty means no available images.
`data.data.data.candidates[].jurisdiction_iso2`	`any`	optional	Registration jurisdiction, distinct from protected jurisdictions.
`data.data.data.candidates[].locarno_classes`	`any`	optional	Preserve output codes such as 06.01 or 09-01; requests still require NN-NN.
`data.data.data.candidates[].locarno_details`	`any`	optional	Source code, parent_code, label_zh and label_en; missing labels stay unknown.
`data.data.data.candidates[].novelty_statement`	`any`	optional	Source novelty statement; retain original text, not a legal conclusion.
`data.data.data.candidates[].primary_identifier`	`any`	optional	Primary display number; retain leading zeros.
`data.data.data.candidates[].protected_jurisdictions`	`any`	optional	HAGUE designated states or ordinary registration jurisdiction; null means unknown, never fill from regions.
`data.data.data.candidates[].publication_date`	`any`	optional	Source publication date, YYYY-MM-DD.
`data.data.data.candidates[].publication_number`	`any`	optional	Source publication number; missing or null means unknown.
`data.data.data.candidates[].registration_date`	`any`	optional	Source registration date, YYYY-MM-DD.
`data.data.data.candidates[].registration_jurisdiction_code`	`any`	optional	Source jurisdiction code such as EU, EMID or USID; do not rewrite as ISO-2.
`data.data.data.candidates[].registration_number`	`any`	optional	Source registration number.
`data.data.data.candidates[].risk_level`	`any`	optional	Source risk hint, separate from score and legal status; not an infringement verdict.
`data.data.data.candidates[].similarity`	`any`	optional	Final 0-100 score, not a probability. Preserve returned order; never multiply by 100 or sort again.
`data.data.data.candidates[].simple_legal_status`	`any`	optional	Source legal status; do not infer it from similarity.
`data.data.data.candidates[].specification`	`any`	optional	Source JSON of any shape, or null; preserve actual structure without filling gaps.
`data.data.data.candidates[].title`	`any`	optional	Source title, which may be a number.
`data.data.data.candidates[].title_en`	`any`	optional	Source English title; do not translate missing values.
`data.data.data.candidates[].title_language`	`any`	optional	Source title language; may be unknown.
`data.data.data.candidates[].tro_cases`	`any`	optional	Current TRO corpus associations; empty is not confirmation of no TRO.
`data.data.data.coverage`	`any`	optional	Optional source coverage; do not infer completeness.
`data.data.data.total`	`any`	optional	Returned candidate count, not corpus size or user billing units.
`data.data.data.warnings`	`any`	optional	Optional source limitations.
`data.data.message`	`any`	optional	Source status message.
`data.data.request_id`	`any`	optional	Upstream request identifier; keep separate from requestId.
`data.data.usage`	`any`	optional	Source-account usage; not user debit or balance.
`data.dataSnapshotMonth`	`any`	optional	Data snapshot month returned by the upstream provider.
`data.page`	`any`	optional	Current page returned by the upstream provider.
`data.pageItemCount`	`any`	optional	Item count on the current page returned by the upstream provider.
`data.pageSize`	`any`	optional	Page size returned by the upstream provider.
`data.requestId`	`any`	optional	Gateway/service error request identifier; distinct from upstream request_id.
`data.sourceTool`	`any`	optional	Provider-specific source tool name.
`data.sourceType`	`any`	optional	Provider-specific source platform type.
`data.title`	`any`	optional	Provider-specific response title.
`data.totalPage`	`any`	optional	Total page count returned by the upstream provider.
`data.type`	`any`	optional	Provider-specific render or payload type.
`data.upstreamRequestId`	`any`	optional	Extracted upstream request identifier.

Any of option 1

Name	Type	Required	Description
`data.costTime`	`integer`	optional	Execution time reported by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.costTime`	`null`	optional	Execution time reported by the upstream provider.

Any of option 1

Name	Type	Required	Description
`data.costToken`	`integer`	optional	Token cost reported by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.costToken`	`null`	optional	Token cost reported by the upstream provider.

Any of option 1

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	Source applicant objects with name and address; never infer protection jurisdictions.
`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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].applicant_addresses`	`null`	optional	Source applicant objects with name and address; never infer protection jurisdictions.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].application_date`	`string`	optional	Source application date, YYYY-MM-DD. Example: 2010-04-13

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].application_date`	`null`	optional	Source application date, YYYY-MM-DD.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].application_number`	`string`	optional	Source application number. Example: 001694860

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].application_number`	`null`	optional	Source application number.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].design_registration_id`	`null`	optional	Exact registration ID for details; preserve unchanged.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].designer_names`	`array`	optional	Source designers; missing or null means unknown. Example: null

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].designer_names`	`null`	optional	Source designers; missing or null means unknown.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].estimated_expiration_date`	`null`	optional	Estimated date only, YYYY-MM-DD; not confirmed expiry or invalidity.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].expiration_date_basis`	`null`	optional	Source JSON of any shape, or null; never invent an estimation basis.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].holder_names`	`array`	optional	Source holders; do not resolve numeric identifiers to invented names. Example: ["237302"]

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].holder_names`	`null`	optional	Source holders; do not resolve numeric identifiers to invented names.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].image_url`	`null`	optional	Complete signed first-image URL; when images exist this equals images[0]. Never strip query parameters.

Any of option 1

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	At most six complete signed image URLs in original order; empty means no available images.

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].images`	`null`	optional	At most six complete signed image URLs in original order; empty means no available images.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].jurisdiction_iso2`	`string`	optional	Registration jurisdiction, distinct from protected jurisdictions. Example: EM

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].jurisdiction_iso2`	`null`	optional	Registration jurisdiction, distinct from protected jurisdictions.

Any of option 1

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"]

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].locarno_classes`	`null`	optional	Preserve output codes such as 06.01 or 09-01; requests still require NN-NN.

Any of option 1

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	Source code, parent_code, label_zh and label_en; missing labels stay unknown.
`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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].locarno_details`	`null`	optional	Source code, parent_code, label_zh and label_en; missing labels stay unknown.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].novelty_statement`	`string`	optional	Source novelty statement; retain original text, not a legal conclusion. Example: null

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].novelty_statement`	`null`	optional	Source novelty statement; retain original text, not a legal conclusion.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].primary_identifier`	`string`	optional	Primary display number; retain leading zeros. Example: 001694860-0001

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].primary_identifier`	`null`	optional	Primary display number; retain leading zeros.

Any of option 1

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"]

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].protected_jurisdictions`	`null`	optional	HAGUE designated states or ordinary registration jurisdiction; null means unknown, never fill from regions.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].publication_date`	`string`	optional	Source publication date, YYYY-MM-DD. Example: null

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].publication_date`	`null`	optional	Source publication date, YYYY-MM-DD.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].publication_number`	`string`	optional	Source publication number; missing or null means unknown. Example: null

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].publication_number`	`null`	optional	Source publication number; missing or null means unknown.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].registration_date`	`string`	optional	Source registration date, YYYY-MM-DD. Example: null

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].registration_date`	`null`	optional	Source registration date, YYYY-MM-DD.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].registration_jurisdiction_code`	`null`	optional	Source jurisdiction code such as EU, EMID or USID; do not rewrite as ISO-2.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].registration_number`	`string`	optional	Source registration number. Example: E077151-PC

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].registration_number`	`null`	optional	Source registration number.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].risk_level`	`null`	optional	Source risk hint, separate from score and legal status; not an infringement verdict.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].similarity`	`null`	optional	Final 0-100 score, not a probability. Preserve returned order; never multiply by 100 or sort again.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].simple_legal_status`	`string`	optional	Source legal status; do not infer it from similarity. Example: inactive

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].simple_legal_status`	`null`	optional	Source legal status; do not infer it from similarity.

Any of option 1

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

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].specification`	`null`	optional	Source JSON of any shape, or null; preserve actual structure without filling gaps.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].title`	`string`	optional	Source title, which may be a number. Example: E077151-PC

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].title`	`null`	optional	Source title, which may be a number.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].title_en`	`string`	optional	Source English title; do not translate missing values. Example: Chairs [seats]

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].title_en`	`null`	optional	Source English title; do not translate missing values.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].title_language`	`string`	optional	Source title language; may be unknown. Example: unknown

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].title_language`	`null`	optional	Source title language; may be unknown.

Any of option 1

Name	Type	Required	Description
`data.data.data.candidates[].tro_cases`	`array`	optional	Current TRO corpus associations; empty is not confirmation of no TRO. Example: []

Any of option 2

Name	Type	Required	Description
`data.data.data.candidates[].tro_cases`	`null`	optional	Current TRO corpus associations; empty is not confirmation of no TRO.

Any of option 1

Name	Type	Required	Description
`data.data.data.coverage`	`object`	optional	Optional source coverage; do not infer completeness. Example: {}

Any of option 2

Name	Type	Required	Description
`data.data.data.coverage`	`null`	optional	Optional source coverage; do not infer completeness.

Any of option 1

Name	Type	Required	Description
`data.data.data.total`	`integer`	optional	Returned candidate count, not corpus size or user billing units. Example: 1

Any of option 2

Name	Type	Required	Description
`data.data.data.total`	`null`	optional	Returned candidate count, not corpus size or user billing units.

Any of option 1

Name	Type	Required	Description
`data.data.data.warnings`	`array`	optional	Optional source limitations. Example: []

Any of option 2

Name	Type	Required	Description
`data.data.data.warnings`	`null`	optional	Optional source limitations.

Any of option 1

Name	Type	Required	Description
`data.data.message`	`string`	optional	Source status message. Example: success

Any of option 2

Name	Type	Required	Description
`data.data.message`	`null`	optional	Source status message.

Any of option 1

Name	Type	Required	Description
`data.data.request_id`	`string`	optional	Upstream request identifier; keep separate from requestId. Example: req_example

Any of option 2

Name	Type	Required	Description
`data.data.request_id`	`null`	optional	Upstream request identifier; keep separate from requestId.

Any of option 1

Name	Type	Required	Description
`data.data.usage`	`object`	optional	Source-account usage; not user debit or balance. Example: {}

Any of option 2

Name	Type	Required	Description
`data.data.usage`	`null`	optional	Source-account usage; not user debit or balance.

Any of option 1

Name	Type	Required	Description
`data.dataSnapshotMonth`	`string`	optional	Data snapshot month returned by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.dataSnapshotMonth`	`null`	optional	Data snapshot month returned by the upstream provider.

Any of option 1

Name	Type	Required	Description
`data.page`	`integer`	optional	Current page returned by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.page`	`null`	optional	Current page returned by the upstream provider.

Any of option 1

Name	Type	Required	Description
`data.pageItemCount`	`integer`	optional	Item count on the current page returned by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.pageItemCount`	`null`	optional	Item count on the current page returned by the upstream provider.

Any of option 1

Name	Type	Required	Description
`data.pageSize`	`integer`	optional	Page size returned by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.pageSize`	`null`	optional	Page size returned by the upstream provider.

Any of option 1

Name	Type	Required	Description
`data.requestId`	`string`	optional	Gateway/service error request identifier; distinct from upstream request_id. Example: gateway_example

Any of option 2

Name	Type	Required	Description
`data.requestId`	`null`	optional	Gateway/service error request identifier; distinct from upstream request_id.

Any of option 1

Name	Type	Required	Description
`data.sourceTool`	`string`	optional	Provider-specific source tool name. Example: null

Any of option 2

Name	Type	Required	Description
`data.sourceTool`	`null`	optional	Provider-specific source tool name.

Any of option 1

Name	Type	Required	Description
`data.sourceType`	`string`	optional	Provider-specific source platform type. Example: null

Any of option 2

Name	Type	Required	Description
`data.sourceType`	`null`	optional	Provider-specific source platform type.

Any of option 1

Name	Type	Required	Description
`data.title`	`string`	optional	Provider-specific response title. Example: null

Any of option 2

Name	Type	Required	Description
`data.title`	`null`	optional	Provider-specific response title.

Any of option 1

Name	Type	Required	Description
`data.totalPage`	`integer`	optional	Total page count returned by the upstream provider. Example: null

Any of option 2

Name	Type	Required	Description
`data.totalPage`	`null`	optional	Total page count returned by the upstream provider.

Any of option 1

Name	Type	Required	Description
`data.type`	`string`	optional	Provider-specific render or payload type. Example: null

Any of option 2

Name	Type	Required	Description
`data.type`	`null`	optional	Provider-specific render or payload type.

Any of option 1

Name	Type	Required	Description
`data.upstreamRequestId`	`string`	optional	Extracted upstream request identifier. Example: req_example

Any of option 2

Name	Type	Required	Description
`data.upstreamRequestId`	`null`	optional	Extracted upstream request identifier.

Any of option 2

Name	Type	Required	Description
`data`	`null`	required	Data value used by this API operation.

Examples

Example arguments

{
  "imageUrl": "https://example.com/product.png",
  "title": "Bottle",
  "topK": 20
}

Example structuredContent

{
  "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"
}