Search Images

POST

https://vision-agent.api.reka.ai/images/search

POST

/images/search

1 import requests
2 
3 url = "https://vision-agent.api.reka.ai/images/search"
4 
5 payload = { "query": "string" }
6 headers = {
7     "X-Api-Key": "<apiKey>",
8     "Content-Type": "application/json"
9 }
10 
11 response = requests.post(url, json=payload, headers=headers)
12 
13 print(response.json())

Try it

200Successful

1 {
2   "results": [
3     {
4       "image_id": "string",
5       "image_url": "string",
6       "image_metadata": {
7         "camera_id": "string",
8         "recorded_timestamp_utc": 1,
9         "video_clip_id": "string",
10         "org_id": "string",
11         "site_id": "string",
12         "event_id": "string",
13         "detection_metadata": [
14           {
15             "class_name": "string",
16             "bounding_box": [
17               1
18             ],
19             "confidence": 1.1,
20             "is_license_plate": false,
21             "license_plate_number": "string",
22             "ncic_category": "string"
23           }
24         ]
25       },
26       "upload_timestamp": 1.1,
27       "score": 1.1
28     }
29   ]
30 }

Search for images with a plaintext query

Authentication

X-Api-Keystring

API key authentication via X-Api-Key header

AuthorizationBearer

Bearer token authentication via Authorization header

Request

This endpoint expects an object.

querystringRequired>=1 character

Search query text

max_resultsintegerOptional<=200Defaults to 10

Maximum number of results to return

thresholddouble or nullOptional

similarity score

Response

Successful Response

resultslist of objects