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

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
index_name
string
required

Query Parameters

​
image_url
string

Image URL to download image from. One of image_url / image_file must be provided.

Body

multipart/form-data
​
image_file
file

Image file upload. One of image_url / image_file must be provided.

​
metadata_str
string
default:{}

Metadata dict for the video. See documentation for structure.

Response

Successful Response