Image Search

Identify Card from Image

Changed on

AI-powered upgrade to POST /v1/cards/image-search. Where image-search returns a ranked list of visually similar candidates, image-match uses AI to pick the single best_match card and resolve its color/finish variant (e.g. Base vs. Silver vs. Red).

Returns best_match (null when the AI isn't confident) plus the candidates it considered, so callers can fall back to the ranked list when the match is uncertain. The best match and every candidate carry the card's prices section (grade/price pairs, one per grade), so a caller can show a price without a second request.

post/v1/cards/image-match

Request

  • Base URL
    https://api.cardhedger.com
  • Auth
    API key in header X-API-Key

Request body

image_urlstring nullable

Public URL to the card image

image_base64string nullable

Base64-encoded image data (data-URI prefix optional)

kinteger

Ximilar recall breadth — number of similar cards to retrieve

Example request

{
  "image_url": "https://example.com/card.jpg",
  "k": 10
}

Response

Successful match with the disambiguated best card and the candidates considered

successboolean required

Whether the search ran without error

query_idstring required

Ximilar query record ID

messagestring nullable

Human-readable status

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status