Skip to main content
Search screen and audio content
curl --request GET \
  --url https://api.example.com/search
import requests

url = "https://api.example.com/search"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/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.example.com/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.example.com/search"

req, _ := http.NewRequest("GET", url, nil)

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

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

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/search")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/search")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "data": [
    {
      "type": "OCR",
      "content": {
        "frame_id": 123,
        "text": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "file_path": "<string>",
        "offset_index": 123,
        "app_name": "<string>",
        "window_name": "<string>",
        "tags": [
          "<string>"
        ],
        "frame": "<string>",
        "frame_name": "<string>",
        "browser_url": "<string>",
        "focused": true,
        "device_name": "<string>"
      }
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "total": 123
  },
  "cloud": {
    "cloudSearchAvailable": true,
    "cloudHasRelevantData": true,
    "cloudQueryHint": "<string>"
  }
}

Query Parameters

q
string | null
limit
integer
offset
integer
content_type
enum<string>
Available options:
all,
ocr,
audio,
input,
accessibility,
memory
start_time
string<date-time> | null
end_time
string<date-time> | null
app_name
string | null
window_name
string | null
frame_name
string | null
include_frames
boolean
min_length
integer | null
max_length
integer | null
speaker_ids
integer[] | null
focused
boolean | null
browser_url
string | null
speaker_name
string | null
include_cloud
boolean
max_content_length
integer | null
device_name
string | null
machine_id
string | null

Response

200 - application/json

OK

data
object[]
required
pagination
object
required
cloud
object

Metadata about cloud search to include in responses.