Before you get started

Run through this checklist before integrating CardSearchEngine. Most issues come from one of these:

Are your reference images clean and tightly cropped?

Cards or products should fill the frame with minimal background and clutter.

Are your filepaths or IDs consistent and meaningful?

Use identifiers that map directly to your database records so you can reliably retrieve images and metadata.

Are your query images the right size?

For /search    and /search_ocr  , images should be 600 pixels on the shortest side. Larger images do not improve results and will increase response time due to resizing.

Are your query images coming from real user conditions?

Test with photos from phones, including glare, angles, and partial visibility, not perfect studio images.

Are you correctly using match results?

Use the returned filepath to retrieve the correct image and metadata from your system before displaying results to users.

Are you handling errors properly?

Check API responses for errors and handle them appropriately. Failed requests or invalid inputs can prevent results from being returned.