POST
/
search
Search across video files and segments to find relevant content
curl --request POST \
  --url https://api.cloudglue.dev/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "scope": "file",
  "collections": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "query": "<string>",
  "limit": 10,
  "filter": {
    "metadata": [
      {
        "path": "<string>",
        "operator": "NotEqual",
        "valueText": "<string>",
        "valueTextArray": [
          "<string>"
        ]
      }
    ],
    "video_info": [
      {
        "path": "duration_seconds",
        "operator": "NotEqual",
        "valueText": "<string>",
        "valueTextArray": [
          "<string>"
        ]
      }
    ],
    "file": [
      {
        "path": "bytes",
        "operator": "NotEqual",
        "valueText": "<string>",
        "valueTextArray": [
          "<string>"
        ]
      }
    ]
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "search",
  "query": "<string>",
  "scope": "file",
  "results": [
    {
      "type": "file",
      "file_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "collection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "score": 123,
      "filename": "<string>",
      "summary": "<string>",
      "generated_title": "<string>",
      "thumbnail_url": "<string>"
    }
  ],
  "total": 123,
  "limit": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Search parameters

​
scope
enum<string>
required

Search scope - 'file' searches at file level (requires collections with enable_summary=true), 'segment' searches at segment level

Available options:
file,
segment
​
collections
string<uuid>[]
required

List of collection IDs to search within. All collections must be of collection_type 'media-descriptions' or 'rich-transcripts'.

For file-level search, collections must have 'enable_summary: true' in transcribe_config.

Minimum length: 1
​
query
string
required

Text search query to find relevant content

Minimum length: 1
​
limit
integer
default:10

Maximum number of search results to return

Required range: 1 <= x <= 100
​
filter
object

Response

Successful search results

​
id
string<uuid>
required

ID of the search response

​
object
enum<string>
required

Object type, always 'search'

Available options:
search
​
query
string
required

The search query that was executed

​
scope
enum<string>
required

The search scope that was used

Available options:
file,
segment
​
results
object[]
required

Array of search results ranked by relevance score

​
total
integer
required

Total number of results returned

​
limit
integer
required

The limit that was applied to the search