Skip to main content
POST
/
index
/
{index_name}
/
search_image
Search By Image
curl --request POST \
  --url https://api.example.com/index/{index_name}/search_image \
  --header 'Content-Type: multipart/form-data' \
  --header 'X-API-Key: <api-key>' \
  --form image_file='@example-file'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Path Parameters

index_name
string
required

Query Parameters

top_k
integer
default:30

Number of segments to return

Body

multipart/form-data
image_file
file
required

Upload image for search

Response

Successful Response