Skip to main content
POST
/
serve
/
api
/
v1
/
search_clips_by_image
Search Clips by Image
curl --request POST \
  --url https://api.memories.ai/serve/api/v1/search_clips_by_image \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form video_no=VI625239098370850816 \
  --form 'prompt=Find clips matching this image' \
  --form unique_id=default
{
  "code": "0000",
  "msg": "success",
  "data": {},
  "success": true,
  "failed": false
}

​
Overview

The Search Clips by Image API lets you upload an image and find the most relevant time ranges (clips) within a specified video that visually match the uploaded image. You can also steer the result with a natural-language prompt (in English) to focus on particular attributes (e.g., clothing silhouette, style) while ignoring others (e.g., color).

​
Host URL

https://api.memories.ai

​
Endpoint

POST /serve/api/v1/search_clips_by_image

​
Authentication

All requests must include the API key in the Authorization header. 
Authorization: <YOUR_API__KEY>

​
Request Parameters

Content-Type: multipart/form-data
​
file
file
required
The image file to search with.
​
video_no
string
required
The unique video identifier (e.g., VI624183999380340736) to search within.
​
prompt
string
Optional natural language prompt to refine the visual search (e.g., “focus on the red shirt”). Please use English.
​
unique_id
string
Optional unique ID filter.

​
Notes

  • Please use English in your scripts when forming the prompt.
  • The legacy base https://ppe-backend.memories.ai should be replaced with https://api.memories.ai in all endpoint URLs.

Authorizations

​
Authorization
string
header
required

Body

multipart/form-data
​
file
file
required
​
video_no
string
required
Example:

"VI625239098370850816"

​
prompt
string
Example:

"Find clips matching this image"

​
unique_id
string
default:default

Response

200 - application/json

Successful response

​
code
Example:

"0000"

​
msg
string
Example:

"success"

​
data
​
success
boolean
Example:

true

​
failed
boolean
Example:

false