Pureframe AI API Documentation

Provide a reference image to find visually similar moments. Use image search when an example communicates the desired appearance better than a text description.

curl -X POST https://api.pureframe.ai/v1/search \
  -H "Authorization: Bearer pf_..." \
  -F "image=@reference.jpg"

Or supply a public URL instead of uploading a file:

curl -X POST https://api.pureframe.ai/v1/search \
  -H "Authorization: Bearer pf_..." \
  -F "image_url=https://example.com/reference.jpg"

Send either image or image_url, never both. Unlike text search, collection_id is optional: omitting it searches your entire library.

Constraints

Max file size: 10 MB
Minimum dimensions: 64×64 pixels. Smaller images are rejected because they may not match reliably
image_url must resolve to a publicly accessible image. Private, loopback, and link-local addresses are rejected.

What it matches

Image search returns visual matches as frame segments. Add query when you want text to narrow the intent of the reference image.

curl -X POST https://api.pureframe.ai/v1/search \
  -H "Authorization: Bearer pf_..." \
  -F "image=@product-shot.jpg" \
  -F "query=on a store shelf" \
  -F "collection_id=col_abc123"

Combining with text-derived filters

Pass labels with an image query to restrict matches to specific scene labels. See Combined queries.