Skip to main content
GET
/
search
/
{search_id}
Get a search response by ID
curl --request GET \
  --url https://api.cloudglue.dev/v1/search/{search_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "object": "search",
  "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,
  "query": "<string>",
  "group_by_key": "file",
  "group_count": 123,
  "search_modalities": [
    "general_content"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
search_id
string<uuid>
required

The ID of the search response to get

Response

A search response

​
id
string<uuid>
required

ID of the search response

​
object
enum<string>
required

Object type, always 'search'

Available options:
search
​
scope
enum<string>
required

The search scope that was used

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

Array of search results ranked by relevance score

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
​
total
integer
required

Total number of results returned. When group_by_key is specified, this represents the total number of items across all groups (not the number of groups).

​
limit
integer
required

The limit that was applied to the search

​
query
string

The search query that was executed (for text search) or the source image URL/base64 indicator (for face search)

​
group_by_key
enum<string>

The key used for grouping results. Only present when group_by_key was specified in the request and results are grouped.

Available options:
file
​
group_count
integer

Number of groups in the results. Only present when group_by_key is specified.

​
search_modalities
enum<string>[]

The search modalities that were used

Available options:
general_content,
speech_lexical,
ocr_lexical