Add Match Image API

The Add Match Image API allows you to add a single product image to an existing custom Match Image tool index, so the agent can match customer-sent photos against your catalog.

API Endpoint

https://service.tailortalk.ai/api/v1/add_match_image

Headers

Key Value
Authorization Agent <token>
Content-Type application/json

You can find agent_token on the Developer page, under the API Keys tab. Click the eye icon to reveal it, or the copy icon to copy it.

text

Request Body

Parameter Required Description
image_url ✅ Publicly accessible product image URL
metadata ❌ Additional product information (e.g. SKU, name, color, price) stored alongside the image and returned when a match is found

Example Request

{
    "image_url": "https://example.com/products/red-shirt.jpg",
    "metadata": {
        "sku": "SKU123",
        "product_name": "Red Shirt",
        "color": "red",
        "price": "499"
    }
}

Response Format

The API returns a JSON object confirming the image was added. The response payload is wrapped automatically under a data field with success: true:

{
    "data": {
        "message": "Image added to the match-image index.",
        "image_url": "https://example.com/products/red-shirt.jpg"
    },
    "success": true
}

Notes

  • Ensure that the agent access token is included in the request headers.
  • The agent token determines which agent's Match Image tool the image is added to — agent_id is derived from the token and does not need to be included in the request body.
  • image_url must be publicly accessible; TailorTalk fetches it directly to index the image.
  • The target agent must already have a Match Image tool configured with source_type set to CUSTOM.
XLinkedIn