Search scenes
search_scenesRead-only
Find scenes across multiple stash-box catalogues using text queries or filters for performer, tag, studio, date, and sort. Results are returned per catalogue, indicating matches, misses, or empty sets.
Instructions
Search scenes across every configured stash-box catalogue. Two exclusive paths: 'query' runs each catalogue's own text index, which reads the words as a union, and the typed arguments narrow as an intersection. Writing both is refused. The answer says per catalogue which of three it met: a failure, a catalogue nobody asked, and an emptiness it established. Counts are never added across them.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | ||
| date | No | ||
| page | No | Which page of its own order every catalogue asked is read at, counted from 1. A search written with words alone reads the first rows each text index answers with, since those routes take no page. | |
| sort | No | ||
| alias | No | No catalogue's faceted route applies it, though every faceted input declares it: a request carrying it answers as wide as one carrying none, so it is never sent and the answer names it as a narrowing nobody received. | |
| limit | No | How many rows one page of one catalogue carries. An answer holding several carries up to this many from each: their pages are their own and nothing here interleaves them into one. | |
| match | No | How performer_ids and tag_ids are read, which are the only arguments it governs. 'all', the default, asks for scenes carrying every identifier of a list; 'any' for scenes carrying at least one, which answers counts an order of magnitude wider. A scene names one studio, so studio_ids asks for any of its identifiers under both readings. The lists narrow against each other as an intersection either way. | |
| query | No | Words for the catalogue's own text index, which reads them as a union. It is exclusive with the typed arguments, which narrow as an intersection. | |
| title | No | ||
| sources | No | ||
| tag_ids | No | ||
| direction | No | ||
| studio_ids | No | ||
| date_compare | No | These catalogues compare a date against one bound and answer no range, so the comparison is written rather than assumed. | |
| performer_ids | No | ||
| parent_studio_id | No |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | Yes | ||
| cached | No | Replayed from this client's store. | |
| window | No | The page and the row limit this answer was read at, absent where no catalogue answered. | |
| results | Yes | ||
| ordering | Yes | How the rows were laid out, which a reader needs before reading the first. | |
| per_source | Yes | ||
| result_count | Yes | How many rows this page carries. |