Search Library Images
search_user_imagesFind Brand Library images by visual meaning. Search for the pictured subject. In select mode, wait for the user's choice or skip; use display mode only when the choice is delegated. Empty results mean no relevant matches were found.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"brand_session_id": "<brand_session_id>",
"query": "<query>"
},
"name": "search_user_images"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | No | Use "select" when the user should choose results, or "display" when the agent can use them directly. | select |
| query | Yes | Describe what is pictured using a short noun phrase of one to four words, such as a product or scene. | |
| top_k | No | How many matching Library images to return at most. | |
| llm_model | No | The model identifier you are running as, for example "claude-opus-4-8" or "gpt-5.2". Omit it or pass "unknown" if you are not certain; the tool runs the same either way. Recorded only for the server developer's analytics. | |
| brand_session_id | Yes | Brand session ID from `list_brands` for the brand whose Library to search. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mode | Yes | Mode the request used. | |
| query | Yes | Search query the request used. | |
| candidates | Yes | Matching Brand Library images. Empty when nothing matched. | |
| message_for_assistant | No | Context, explanations, or actionable guidance for the calling assistant. Hosts may display it, but it is not copy that must be shown to the user verbatim. |