Read one scene
get_sceneRead-onlyIdempotent
Retrieve a scene's full details using its identifier from the stash-box catalogue. Optionally load fingerprints or images sections.
Instructions
Read one catalogued scene by its identifier. The identifier names the catalogue that minted it, as returned by search_scenes or find_by_fingerprint. Sections are opt-in because a scene's fingerprints weigh more than everything else it carries.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Identifier as returned by another tool, such as stashdb:<uuid>. | |
| sections | No | Which blocks to load. Defaults to basic. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| code | No | The studio's own reference, in whatever form it publishes. | |
| tags | No | ||
| urls | No | ||
| notes | Yes | ||
| title | No | ||
| images | No | ||
| source | Yes | ||
| status | Yes | 'established' is a record the catalogue holds. 'merged' and 'deleted' are markers: the identifier resolves, and what comes back describes the record rather than the thing it once named. | |
| studio | No | ||
| created | No | ||
| details | No | ||
| updated | No | ||
| director | No | Free text, which can name several people. | |
| performers | No | ||
| source_url | Yes | ||
| merged_into | No | Present on a marker: the identifier that continues this record. | |
| fingerprints | No | ||
| former_title | No | Present on a marker: the title the record carried. | |
| release_date | No | When the scene was published. | |
| retrieved_at | Yes | When this record came off the catalogue, ISO 8601. | |
| production_date | No | When the scene was made, which is a different question from when it was published. Rarely recorded, and never filled in from the release date. | |
| duration_seconds | No | ||
| fingerprint_count | No | ||
| fingerprints_held | No | How many the record holds, where the section shows a page of them. |