Search scenes
search_scenesRead-onlyIdempotent
Search scenes across multiple stash-box catalogues with full-text or faceted queries. Each catalogue reports its own count and status (failed, not asked, or no matches).
Instructions
Ask every configured catalogue for scenes. The two paths are exclusive: giving 'query' runs the full-text search and every typed argument is reported as not received, while omitting it runs the faceted query on the typed arguments. A catalogue offering no full-text search is named as absent from a 'query' search, and dropping 'query' for 'title' reaches it. Counts are per catalogue and are never added, and a catalogue that failed, one never asked and one that found nothing are three different states an answer names.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| code | No | The studio's own reference for the scene. | |
| page | No | ||
| sort | No | ||
| limit | No | ||
| query | No | Free text matched against a scene's own fields. | |
| title | No | ||
| date_to | No | Latest release date, as YYYY-MM-DD. | |
| sources | No | ||
| tag_ids | No | ||
| date_from | No | Earliest release date, as YYYY-MM-DD. | |
| direction | No | ||
| studio_ids | No | ||
| performer_ids | No | Namespaced performer identifiers. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| notes | Yes | ||
| query | Yes | ||
| window | No | The window this answer covers, per catalogue. An emptiness here is an emptiness inside that window. | |
| results | Yes | ||
| ordering | Yes | How the order was built. The catalogues publish no score in common, so rows interleave and nothing is ranked across them. | |
| per_source | Yes | ||
| result_count | Yes | Rows returned here. Counts are never added across catalogues. |