Upload image

This API allows you to upload an image for Visual Search.

Endpoints

• Production: https://pathways.dxpapi.com/api/v2/widgets/visual/upload/{widget_id}
• Staging: https://pathways-staging.dxpapi.com/api/v2/widgets/visual/upload/{widget_id}

Response Example

🚧

The request payload should not exceed 2 MB.

The response provides you with the image_id value.

image_id can be used to make multiple subsequent queries for widget responses (with different parameters/filters and objects) without the need to re-upload the image.

{
    "response": {
       "image_id": "3d4b4331763c31b39da02704d48e890f90c36ef6b4835eface4820a3e1127987"
    },
    "metadata": {
        "widget": {
            "id": "79opvm5j",
            "name": "preview",
            "description": "preview",
            "type": "visual_search",
            "rid": "680d0382-7297-4db7-9df7-61522b4612c7"
        },
        "query": {
            "image_id": "3d4b4331763c31b39da02704d48e890f90c36ef6b4835eface4820a3e1127987"
        }
    }
}