POST search_metadata¶

Resource URL
Notes
Parameters
Request examples
Response examples
- JSON
- XML

Given some metadata, search against your collection and return all matching images.

Resource URL ¶

https://multicolorengine.tineye.com/<company>/rest/search_metadata/

Notes ¶

Image IDs and metadata are combined using an AND operator and used to perform a metadata search again the whole collection. The collection images containing the query metadata are returned.

Parameters ¶

In addition to the Common parameters there are:

Key	Description
image_id (optional)	The image ID to search for.
metadata (optional)	The metadata to be used for additional filtering.
return_metadata (optional)	The metadata to be returned with each match.
name_filter (optional)	Return only matches whose names match this filter (see Name Filtering for details).
path_filter (optional)	Return only matches whose paths match this filter (see Name Filtering for details).
offset (optional)	The offset of results from the start, defaults to 0.
limit (optional)	The maximum number of matches that should be returned, defaults to 10. A value of 0 indicates no limit.

Request examples ¶

curl https://multicolorengine.tineye.com/<company>/rest/search_metadata/  \
     -F "image_id=dd8d-6dc8-bf3f"                                         \
     -F "metadata='{\"keywords\": \"whale\"}'"                            \
     -F "limit=10"

Response examples ¶

JSON ¶

{
    "method": "search_metadata",
    "status": "ok",
    "error": [],
    "result": [
        {
            "filepath": "image01.jpg"
        },
        {
            "filepath": "image02.jpg"
        },
        {
            "filepath": "image03.jpg"
        }
    ],
    "stats": {
        "total_results": 3,
        "total_filtered_results": 3,
        "total_returned_results": 3,
        "time_search_metadata": 4.7,
        "time_total": 5.04
    }
}

XML ¶

<?xml version="1.0" encoding="utf-8"?>
<data>
    <method>search_metadata</method>
    <status>ok</status>
    <error/>
    <result>
        <item>
            <filepath>image01.jpg</filepath>
        </item>
        <item>
            <filepath>image02.jpg</filepath>
        </item>
        <item>
            <filepath>image03.jpg</filepath>
        </item>
    </result>
    <stats>
        <total_results>3</total_results>
        <total_filtered_results>3</total_filtered_results>
        <total_returned_results>3</total_returned_results>
        <time_search_metadata>4.7</time_search_metadata>
        <time_total>5.04</time_total>
    </stats>
</data>