Home

Shotgun provides a simple Python-based API for accessing Shotgun and integrating with other tools. This is the official API that is maintained by Shotgun Software (support@shotgunsoftware.com)

Minimum Requirements

• Shotgun server v5.4.14 or higher for API v3.0.16.
• Shotgun server v2.4.12 or higher for API v3.0.8.
• Shotgun server v1.8 or higher for API v3.0.7.
• Python v2.4 - v2.7. (We do have plans to eventually support Python 3)

Installation

To use Shotgun's Python API module, you need to place it in one of the directories specified by the environment variable PYTHONPATH. For more information on PYTHONPATH and using modules in Python, see http://docs.python.org/tutorial/modules.html

Getting Started

• API Overview
• Setting Up Shotgun for API Access
• API Usage Tips
• Shotgun Server API Changelog

Reference

• Reference: Methods
• Reference: Data Types
• Reference: Filter Syntax

Files

• Working With Local Files
• Working With Files (Attachments)

Tutorial Examples

• Create the Server Connection
• Create a Shot
• Find a Shot
• Update a Shot
• Delete a Shot
• Create a Shot with a Task Template
• Create a Version and link it to a Shot
• Upload a Thumbnail to a Version

Examples + Advanced Usage

• Accessing CustomEntities via the API
• Task Dependencies
• Task Status Triggers
• Updating Task Dates: How Shotgun Thinks
• Split Tasks
• Event Types
• Subversion (SVN) Integration
• Handling ActionMenuItems
• Using an ActionMenuItem to Package Versions for a Client
• Smart Cut Fields
• Connection Entities
• Packaging an application with py2app (or py2exe)