Search reference images
search_refsUse this when the user wants to find references they saved, by words such as "dark editorial layout with a serif headline", or by giving another image to find similar ones. Pass the profile_key and exactly one of query_text, query_image_url or query_file. Returns the closest references with their name, summary, palette and a closeness score. It searches only this user's saved references, never the web.
Example tool call
This call uses example arguments supplied in the tool’s input schema.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"query_text": "dark editorial layout with a serif headline",
"profile_key": "tp_604a48a85c9a4da5a2a15ba7b4198f1b"
},
"name": "search_refs"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | How many matches to return; default 5. | |
| query_file | No | An uploaded image to find similar references for. | |
| query_text | No | Words describing the look to find, such as "dark editorial layout with a serif headline". | |
| profile_key | Yes | The profile_key that add_refs returned. Keep it: it is the only way back to this profile and it is not recoverable. | |
| query_image_url | No | A public https link to an image to find similar references for. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| as_of | Yes | UTC date of this answer. | |
| query | Yes | ||
| notice | Yes | ||
| source | Yes | ||
| status | Yes | ||
| matches | Yes | ||
| refs_total | Yes |