# Previews

Preview generation and thumbnail management. 

```json
PreviewFile {
  "type": "object",
  "properties": {
    "shotgun_id": {
      "type": "integer",
      "description": "Used for synchronization with a Shotgun instance"
    },
    "name": {
      "type": "string",
      "description": "Name of preview file"
    },
    "original_name": {
      "type": "string",
      "description": "Original name of preview file"
    },
    "revision": {
      "type": "integer",
      "default": "1",
      "description": "Revision number of preview file"
    },
    "position": {
      "type": "integer",
      "default": "1",
      "description": "Position of preview file"
    },
    "extension": {
      "type": "string",
      "description": "Extension of preview file"
    },
    "description": {
      "type": "string",
      "description": "Preview file brief"
    },
    "path": {
      "type": "string",
      "description": "File path on the production hard drive"
    },
    "source": {
      "type": "string",
      "description": "Created by a script, a webgui or a desktop gui"
    },
    "file_size": {
      "type": "integer",
      "default": "0",
      "description": "Size of output file"
    },
    "comment": {
      "type": "string",
      "description": "Comment on output file"
    },
    "checksum": {
      "type": "string",
      "description": "Checksum of output file"
    },
    "representation": {
      "type": "string",
      "description": "Precise what kind of output it is (abc, jpgs, pngs, etc.)"
    },
    "nb_elements": {
      "type": "integer",
      "default": "1",
      "description": "For image sequence"
    },
    "canceled": {
      "type": "boolean"
    },
    "file_status_id": {
      "type": "string",
      "format": "UUID",
      "description": "File status ID"
    },
    "entity_id": {
      "type": "string",
      "format": "UUID",
      "description": "Asset or Shot concerned by the output file"
    },
    "asset_instance_id": {
      "type": "string",
      "format": "UUID",
      "description": "Asset instance ID"
    },
    "output_type_id": {
      "type": "string",
      "format": "UUID",
      "description": "Type of output (geometry, cache, etc.)"
    },
    "task_type_id": {
      "type": "string",
      "format": "UUID",
      "description": "Task type related to this output file (modeling, animation, etc.)"
    },
    "person_id": {
      "type": "string",
      "format": "UUID",
      "description": "Author of the file"
    },
    "source_file_id": {
      "type": "string",
      "format": "UUID",
      "description": "Working file that led to create this output file"
    },
    "temporal_entity_id": {
      "type": "string",
      "format": "UUID",
      "description": "Shot, scene or sequence needed for output files related to an asset instance"
    },
    "data": {
      "type": "string",
      "format": "json",
      "description": "Free JSON field to add metadata"
    }
  }
}
```


## Operations
- [Get running preview files](https://api-docs.kitsu.cloud/operation/operation-get-data-playlists-preview-files-running.md)
- [Create preview file](https://api-docs.kitsu.cloud/operation/operation-post-pictures-preview-files-parameter.md)
- [Get preview movie](https://api-docs.kitsu.cloud/operation/operation-get-movies-originals-preview-files-parameter-mp4.md)
- [Download preview movie](https://api-docs.kitsu.cloud/operation/operation-get-movies-originals-preview-files-parameter-download.md)
- [Get preview lowdef movie](https://api-docs.kitsu.cloud/operation/operation-get-movies-low-preview-files-parameter-mp4.md)
- [Get preview thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-preview-files-parameter-png.md)
- [Get attachment thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-attachment-files-parameter-png.md)
- [Get preview thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-square-preview-files-parameter-png.md)
- [Get preview thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-originals-preview-files-parameter-png.md)
- [Get preview file](https://api-docs.kitsu.cloud/operation/operation-get-pictures-originals-preview-files-parameter-parameter.md)
- [Download preview file](https://api-docs.kitsu.cloud/operation/operation-get-pictures-originals-preview-files-parameter-download.md)
- [Get preview thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-previews-preview-files-parameter-png.md)
- [Get preview thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-movies-tiles-preview-files-parameter-png.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-organisations-parameter.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-organisations-parameter.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-organisations-parameter-png.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-organisations-parameter-png.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-persons-parameter.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-persons-parameter.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-persons-parameter-png.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-persons-parameter-png.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-projects-parameter.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-projects-parameter.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-projects-parameter-png.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-projects-parameter-png.md)
- [Create preview background file](https://api-docs.kitsu.cloud/operation/operation-post-pictures-preview-background-files-parameter.md)
- [Get thumbnail](https://api-docs.kitsu.cloud/operation/operation-get-pictures-thumbnails-preview-background-files-parameter-png.md)
- [Create thumbnail](https://api-docs.kitsu.cloud/operation/operation-post-pictures-thumbnails-preview-background-files-parameter-png.md)
- [Get preview background file](https://api-docs.kitsu.cloud/operation/operation-get-pictures-preview-background-files-parameter-parameter.md)
- [Set main preview](https://api-docs.kitsu.cloud/operation/operation-put-actions-preview-files-parameter-set-main-preview.md)
- [Extract frame from preview](https://api-docs.kitsu.cloud/operation/operation-get-actions-preview-files-parameter-extract-frame.md)
- [Update preview position](https://api-docs.kitsu.cloud/operation/operation-put-actions-preview-files-parameter-update-position.md)
- [Update preview annotations](https://api-docs.kitsu.cloud/operation/operation-put-actions-preview-files-parameter-update-annotations.md)
- [Extract tile from preview](https://api-docs.kitsu.cloud/operation/operation-get-actions-preview-files-parameter-extract-tile.md)

[Powered by Bump.sh](https://bump.sh)