Search
curl --request POST \
--url https://api.pureframe.ai/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'query=<string>' \
--form 'image=<string>' \
--form 'image_url=<string>' \
--form 'collection_id=<string>' \
--form 'modes[0]=video' \
--form 'modes[1]=transcript' \
--form 'modes[2]=scene' \
--form natural_language=false \
--form page=1 \
--form per_page=10 \
--form include_hidden=falseimport requests
url = "https://api.pureframe.ai/v1/search"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('query', '<string>');
form.append('image', '<string>');
form.append('image_url', '<string>');
form.append('collection_id', '<string>');
form.append('modes[0]', 'video');
form.append('modes[1]', 'transcript');
form.append('modes[2]', 'scene');
form.append('natural_language', 'false');
form.append('page', '1');
form.append('per_page', '10');
form.append('include_hidden', 'false');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.pureframe.ai/v1/search', 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.pureframe.ai/v1/search",
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=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.pureframe.ai/v1/search"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.pureframe.ai/v1/search")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pureframe.ai/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": [
{
"video_id": "<string>",
"segments": [
{
"timestamp_start": 123,
"timestamp_end": 123,
"score": 123,
"type": "<string>",
"rank": 123,
"text_content": "<string>",
"bbox": {},
"video_url": "<string>",
"thumbnail_url": "<string>",
"hidden": false,
"raw_score": 123,
"threshold_key": "<string>"
}
],
"filename": "<string>",
"collection_id": "<string>",
"status": "<string>"
}
],
"meta": {
"request_id": "<string>",
"took_ms": 123,
"total": 123,
"page": 123,
"per_page": 123,
"facets": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Search
Search
Find timestamped video segments that match text, an image, or both.
POST
/
v1
/
search
Search
curl --request POST \
--url https://api.pureframe.ai/v1/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form 'query=<string>' \
--form 'image=<string>' \
--form 'image_url=<string>' \
--form 'collection_id=<string>' \
--form 'modes[0]=video' \
--form 'modes[1]=transcript' \
--form 'modes[2]=scene' \
--form natural_language=false \
--form page=1 \
--form per_page=10 \
--form include_hidden=falseimport requests
url = "https://api.pureframe.ai/v1/search"
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "multipart/form-data"
}
response = requests.post(url, data=payload, headers=headers)
print(response.text)const form = new FormData();
form.append('query', '<string>');
form.append('image', '<string>');
form.append('image_url', '<string>');
form.append('collection_id', '<string>');
form.append('modes[0]', 'video');
form.append('modes[1]', 'transcript');
form.append('modes[2]', 'scene');
form.append('natural_language', 'false');
form.append('page', '1');
form.append('per_page', '10');
form.append('include_hidden', 'false');
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
options.body = form;
fetch('https://api.pureframe.ai/v1/search', 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.pureframe.ai/v1/search",
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=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.pureframe.ai/v1/search"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.pureframe.ai/v1/search")
.header("Authorization", "Bearer <token>")
.body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pureframe.ai/v1/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"query\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"image_url\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"collection_id\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B0%5D\"\r\n\r\nvideo\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B1%5D\"\r\n\r\ntranscript\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"modes%5B2%5D\"\r\n\r\nscene\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"natural_language\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"page\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"per_page\"\r\n\r\n10\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_hidden\"\r\n\r\nfalse\r\n-----011000010111000001101001--"
response = http.request(request)
puts response.read_body{
"data": [
{
"video_id": "<string>",
"segments": [
{
"timestamp_start": 123,
"timestamp_end": 123,
"score": 123,
"type": "<string>",
"rank": 123,
"text_content": "<string>",
"bbox": {},
"video_url": "<string>",
"thumbnail_url": "<string>",
"hidden": false,
"raw_score": 123,
"threshold_key": "<string>"
}
],
"filename": "<string>",
"collection_id": "<string>",
"status": "<string>"
}
],
"meta": {
"request_id": "<string>",
"took_ms": 123,
"total": 123,
"page": 123,
"per_page": 123,
"facets": {}
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
multipart/form-data