Skip to main content
POST
/
search
/
run
Search
curl --request POST \
  --url http://0.0.0.0:8008/search/run \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "query": "<string>"
}
'
{
  "assets": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "video",
      "name": "<string>",
      "size_bytes": 123,
      "mime_type": "<string>",
      "save_original": true,
      "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "index_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "features": {},
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z",
      "duration": 123,
      "proxy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "preview": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "index_units": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "asset_type": "video",
          "created": "2023-11-07T05:31:56Z",
          "updated": "2023-11-07T05:31:56Z",
          "start_time": 123,
          "end_time": 123
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT in Authorization header. 'Bearer ' prefix optional.

Query Parameters

​
provider_type
enum<string> | null
Available options:
cohere,
mock

Body

application/json

API request schema for searching assets

​
index_id
string<uuid>
required

ID of the index to search within

​
query
string
required

The search query string

Response

Successful Response

API response schema for search results

​
assets
AssetGetResponse · object[]
required

List of assets matching the search query