Search Public — by Image - Memories.ai API

Search Public Videos by Image

curl --request POST \
  --url https://api.memories.ai/serve/api/v1/search_public_similar_images \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form type=TIKTOK \
  --form similarity=0.85

import requests

url = "https://api.memories.ai/serve/api/v1/search_public_similar_images"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "type": "TIKTOK",
    "similarity": "0.85"
}
headers = {"Authorization": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('type', 'TIKTOK');
form.append('similarity', '0.85');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://api.memories.ai/serve/api/v1/search_public_similar_images', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.memories.ai/serve/api/v1/search_public_similar_images",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.memories.ai/serve/api/v1/search_public_similar_images"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.memories.ai/serve/api/v1/search_public_similar_images")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.memories.ai/serve/api/v1/search_public_similar_images")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "code": "0000",
  "msg": "success",
  "data": [
    {
      "videoNo": "PI-600947902470296459",
      "videoName": "Sample public video title",
      "startTime": "79",
      "endTime": "82",
      "score": 0.8631,
      "video_bucket": "mavi-public-video",
      "video_blob": "<scraper-id>.mp4",
      "keyframe_bucket": "mavi-public-keyframe",
      "keyframe_blob": "<uuid>/keyframe-000079.jpg"
    },
    {
      "videoNo": "PI-600947902470296460",
      "videoName": "Another public video",
      "startTime": "32",
      "endTime": "35",
      "score": 0.8712,
      "video_bucket": "mavi-public-video",
      "video_blob": "<scraper-id2>.mp4",
      "keyframe_bucket": "mavi-public-keyframe",
      "keyframe_blob": "<uuid2>/keyframe-000032.jpg"
    }
  ],
  "success": true,
  "failed": false
}

POST

serve

api

search_public_similar_images

Search Public Videos by Image

curl --request POST \
  --url https://api.memories.ai/serve/api/v1/search_public_similar_images \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form file='@example-file' \
  --form type=TIKTOK \
  --form similarity=0.85

import requests

url = "https://api.memories.ai/serve/api/v1/search_public_similar_images"

files = { "file": ("example-file", open("example-file", "rb")) }
payload = {
    "type": "TIKTOK",
    "similarity": "0.85"
}
headers = {"Authorization": "<api-key>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('file', '<string>');
form.append('type', 'TIKTOK');
form.append('similarity', '0.85');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://api.memories.ai/serve/api/v1/search_public_similar_images', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.memories.ai/serve/api/v1/search_public_similar_images",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.memories.ai/serve/api/v1/search_public_similar_images"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.memories.ai/serve/api/v1/search_public_similar_images")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.memories.ai/serve/api/v1/search_public_similar_images")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"type\"\r\n\r\nTIKTOK\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"similarity\"\r\n\r\n0.85\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "code": "0000",
  "msg": "success",
  "data": [
    {
      "videoNo": "PI-600947902470296459",
      "videoName": "Sample public video title",
      "startTime": "79",
      "endTime": "82",
      "score": 0.8631,
      "video_bucket": "mavi-public-video",
      "video_blob": "<scraper-id>.mp4",
      "keyframe_bucket": "mavi-public-keyframe",
      "keyframe_blob": "<uuid>/keyframe-000079.jpg"
    },
    {
      "videoNo": "PI-600947902470296460",
      "videoName": "Another public video",
      "startTime": "32",
      "endTime": "35",
      "score": 0.8712,
      "video_bucket": "mavi-public-video",
      "video_blob": "<scraper-id2>.mp4",
      "keyframe_bucket": "mavi-public-keyframe",
      "keyframe_blob": "<uuid2>/keyframe-000032.jpg"
    }
  ],
  "success": true,
  "failed": false
}

Product: Visual Search Use case: Upload videos and images, auto-index them, then search by natural language, image, or transcript phrase Host: https://api.memories.ai/serve/api/v1 Auth: Authorization: sk-mavi-... (no Bearer prefix)

Upload a query image and retrieve visually similar frames from the pre-indexed public social-media library. For text queries see Search Public — by Text; for exact-phrase transcript search see Search Public — by Transcript.

Prerequisites

You have created a memories.ai API key.

Request Example

Uses multipart/form-data. The file part carries the query image; other parameters are sent as form fields.

import requests

headers = {"Authorization": "sk-mavi-..."}
files = [("file", ("query.png", open("query.png", "rb"), "image/png"))]
data = {"type": "TIKTOK", "similarity": 0.85}

response = requests.post(
    "https://api.memories.ai/serve/api/v1/search_public_similar_images",
    headers=headers,
    files=files,
    data=data
)
print(response.json())

Parameters

file

required

Query image. Allowed: .jpg, .jpeg, .png, .gif, .bmp, .webp. Maximum 20 MB.

string

default:"TIKTOK"

Platform to search. One of TIKTOK, YOUTUBE, INSTAGRAM.

number

default:"0.85"

Minimum similarity threshold (0 – 1). Only results with score ≥ this value are returned.

Response

{
    "code": "0000",
    "msg": "success",
    "data": [
        {
            "videoNo": "PI-600947902470296459",
            "videoName": "Sample public video title",
            "startTime": "79",
            "endTime": "82",
            "score": 0.8631,
            "video_bucket": "mavi-public-video",
            "video_blob": "<scraper-id>.mp4",
            "keyframe_bucket": "mavi-public-keyframe",
            "keyframe_blob": "<uuid>/keyframe-000079.jpg"
        }
    ],
    "success": true,
    "failed": false
}

string

Public video identifier (typically prefixed with PI-).

string

Public video title or name.

string

Matched keyframe start time, in seconds.

string

Matched keyframe end time, in seconds.

number

Visual similarity score (0 – 1).

string

GCS bucket of our cached copy of the public video. Omitted when the storage location cannot be resolved.

string

GCS blob (object) path of the cached video. Use it with video_bucket at GET /serve/api/v2/download?bucket=&blob= to fetch the file directly.

string

GCS bucket of the matched keyframe image.

string

GCS blob (object) path of the matched keyframe image.

Notes & Limits

Rate limiting: Exceeding the per-account rate limit returns an error. See Rate limits.
Billing: Each successful call deducts credits from your account balance.

Authorizations

Authorization

string

header

required

Body

multipart/form-data

file

required

Query image. Allowed extensions: .jpg/.jpeg/.png/.gif/.bmp/.webp. Content-Type must start with image/. Max 20 MB.

type

enum<string>

default:TIKTOK

Source platform to search within.

Available options:

TIKTOK,

YOUTUBE,

INSTAGRAM

similarity

number<double>

default:0.85

Minimum similarity threshold (0-1). Results below this score are filtered out.

Required range: 0 <= x <= 1

Response

200 - application/json

Successful response

code

string

Example:

"0000"

msg

string

Example:

"success"

data

object[]

Show child attributes

success

boolean

Example:

true

failed

boolean

Example:

false

Get Started

Index Upload

Search

Library Management

Folder Management

Reference

Search Public — by Image

Prerequisites

Request Example

Parameters

Response

Notes & Limits

Authorizations

Body

Response

​Prerequisites

​Request Example

​Parameters

​Response

​Notes & Limits

Authorizations

Body

Response

Prerequisites

Request Example

Parameters

Response

Notes & Limits