Reka AI Documentation

curl -X POST https://vision-agent.api.reka.ai/v1/images/search \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "query": "string"
}'

{
  "results": [
    {
      "image_id": "string",
      "image_url": "string",
      "image_metadata": {
        "camera_id": "string",
        "recorded_timestamp_utc": 1,
        "video_clip_id": "string",
        "org_id": "string",
        "site_id": "string",
        "event_id": "string",
        "caption": "string",
        "detection_metadata": [
          {
            "class_name": "string",
            "bounding_box": [
              1
            ],
            "confidence": 1.1,
            "is_license_plate": false,
            "license_plate_number": "string",
            "ncic_category": "string"
          }
        ]
      },
      "upload_timestamp": 1.1,
      "score": 1.1
    }
  ]
}

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

Headers

X-Enable-Overwrite-Meteringstring or nullOptional

Request

This endpoint expects an object.

querystringRequired>=1 character

Search query text

max_resultsintegerOptionalDefaults to 10

search_modeenumOptionalDefaults to vision

Search mode: ‘vision’ for vision-only search, ‘joined’ for hybrid search

Allowed values:

image_weightdouble or nullOptional

Weight of the image in the search (only used when search_mode=‘joined’)

text_weightdouble or nullOptional

Weight of the text in the search (only used when search_mode=‘joined’)

thresholddouble or nullOptional

Similarity score threshold

Response

Successful Response

resultslist of objects

Search Images

Search Images

Authentication

Headers

Request

Response

Authentication

Headers

Request

Response

$	curl -X POST https://vision-agent.api.reka.ai/v1/images/search \
>	-H "X-Api-Key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "string"
>	}'

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	"caption": "string",
14	"detection_metadata": [
15	{
16	"class_name": "string",
17	"bounding_box": [
18	1
19	],
20	"confidence": 1.1,
21	"is_license_plate": false,
22	"license_plate_number": "string",
23	"ncic_category": "string"
24	}
25	]
26	},
27	"upload_timestamp": 1.1,
28	"score": 1.1
29	}
30	]
31	}