SDK method
tools.searchImages
Search images. Convenience alias for search_images, forwarding to tinbox.api.images.search.query.
Signature
ts
searchImages(input: Parameters<TinboxTools["searchImages"]>[0]): ReturnType<TinboxTools["searchImages"]>Parameters
| Name | Type | Required | Description |
|---|---|---|---|
query | string | yes | Search keyword (mode='search') or the image prompt (mode='generate'). |
mode | "search" | "generate" | no | 'search' the stock library (default) or 'generate' an AI placeholder. |
limit | number | no | Max images to return (default 12; ignored for generate). |
orientation | "landscape" | "portrait" | "square" | no | Preferred orientation. Landscape suits email hero images. |
Returns
ReturnType<TinboxTools["searchImages"]>
Example
ts
await tinbox.tools.searchImages({
"query": "invoice"
});