Skip to content

Navigation Menu

Appearance settings

GitHub Copilot
Write better code with AI

GitHub Spark New
Build and deploy intelligent apps

GitHub Models New
Manage and compare prompts

GitHub Advanced Security
Find and fix vulnerabilities

Actions
Automate any workflow
Codespaces
Instant dev environments

Issues
Plan and track work

Code Review
Manage code changes

Discussions
Collaborate outside of code

Code Search
Find more, search less
Explore

Why GitHub

Documentation

GitHub Skills

Blog
Integrations

GitHub Marketplace

MCP Registry
View all features
By company size

Enterprises

Small and medium teams

Startups

Nonprofits
By use case

App Modernization

DevSecOps

DevOps

CI/CD

View all use cases
By industry

Healthcare

Financial services

Manufacturing

Government

View all industries
View all solutions
Topics

AI

DevOps

Security

Software Development

View all
Explore

Learning Pathways

Events & Webinars

Ebooks & Whitepapers

Customer Stories

Partners

Executive Insights
GitHub Sponsors
Fund open source developers
The ReadME Project
GitHub community articles
Repositories

Topics

Trending

Collections
Enterprise platform
AI-powered developer platform
Available add-ons

GitHub Advanced Security
Enterprise-grade security features

Copilot for business
Enterprise-grade AI features

Premium Support
Enterprise-grade 24/7 support
Pricing

Search code, repositories, users, issues, pull requests...

Search

Clear

Search syntax tips

Provide feedback

We read every piece of feedback, and take your input very seriously.

Include my email address so I can be contacted

Saved searches

Use saved searches to filter your results more quickly

Name

Query

To see all available qualifiers, see our documentation.

Appearance settings

You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session.

Dismiss alert

shotgunsoftware / python-api Public

Notifications You must be signed in to change notification settings
Fork 206
Star 315

Code
Issues 37
Pull requests 13
Actions
Projects
Wiki
Security
Insights

Additional navigation options

Code
Issues
Pull requests
Actions
Projects
Wiki
Security
Insights

Home

Jump to bottom

KP edited this page Sep 22, 2016 · 30 revisions

The `python-api` documentation as moved to http://developer.shotgunsoftware.com/python-api

Toggle table of contents Pages 32

Home
Accessing CustomEntities via the API
API Overview
API summary method
API Usage Tips
Event Types
Example: Connection Entities
Example: Create a new Shot and apply a Task Template
Example: Create a Version and link it to a Shot
Example: Creating a Shot
Example: Creating the Server Connection
Example: Deleting a Shot
Example: Finding a Shot
Example: Handling Shotgun ActionMenuItem calls
Example: Task Dependencies
Example: Updating a Shot
Example: Upload a thumbnail for a Version
Example: Using an ActionMenuItem to Package Versions for a Client
Optimization: Combining Related Queries
Packaging an application with py2app (or py2exe)
Production Log Format
Reference: Data Types
Reference: Filter Syntax
Reference: Methods
Setting Up Shotgun for API Access
Shotgun Server API Changelog
Smart Cut Fields
Split Tasks
Subversion (SVN) Integration
Updating Task Dates: How Shotgun Thinks
Working with Files (Attachments)
Working With Local Files

Clone this wiki locally

Footer

© 2025 GitHub, Inc.

Footer navigation

Terms
Privacy
Security
Status
Community
Docs
Contact

You can’t perform that action at this time.