# Disguise Developer Documentation

> Documentation and guidance for building tools and integrations with the Disguise platform.

Disguise is a platform for real-time content production, powering live events, broadcast, film, and fixed installations. This site documents the APIs, SDKs, and plugin system for integrating with Disguise products.

The Designer and SMC APIs run on the Disguise machine on your local network, not on a public host. The Cloud API is a hosted service.

Every page is also available as Markdown: add `.md` to the page URL, for example https://developer.disguise.one/api/introduction.md. The complete documentation in one file is at [llms-full.txt](https://developer.disguise.one/llms-full.txt).

## When to use this documentation

Use these docs when a task involves Disguise (d3) media servers or Disguise Cloud:

- Control a running Designer project or show from code: transport, sequencing, layers, colour, failover, status (Designer API, Python API).
- Find Disguise machines on a network and read their health or hardware state (Designer API discovery, SMC API).
- Build a plugin with its own UI inside Designer, or a remote Python tool that runs code in Designer (Designer Plugins, designer-plugin library).
- Stream real-time content from Unreal, Unity, TouchDesigner or a custom engine into Designer (RenderStream SDK).
- Manage drives and content in Disguise Cloud (Cloud API).

These docs do not cover operating Designer through its user interface. For that, use the user guide at https://help.disguise.one.

## Designer API

REST API for controlling Disguise Designer software.

- [Introduction](https://developer.disguise.one/api/introduction): Overview of the Designer API, authentication, and getting started
- [Discovery](https://developer.disguise.one/api/discovery): Finding Disguise machines on the network via DNS-SD
- [Locator](https://developer.disguise.one/api/locator): Locating specific Designer instances
- [Paths](https://developer.disguise.one/api/paths): API path structure and conventions
- [Error Handling](https://developer.disguise.one/api/error-handling): Error response format and status codes
- [OpenAPI Specs](https://developer.disguise.one/api/openapi): Download OpenAPI/Swagger specifications
- [V1 Notice](https://developer.disguise.one/api/v1-notice): The /api/v1 namespace is deprecated; use /api/service and /api/session

### Guides
- [Media](https://developer.disguise.one/api/guides/media): Manage media files in Designer projects with the Media API
- [Monitoring Machine Health](https://developer.disguise.one/api/guides/monitoring): Monitor machine health, performance and system status
- [Proof of Play](https://developer.disguise.one/api/guides/proof-of-play): Monitor real-time playback across all layers with the Live Update API
- [Working with Sessions](https://developer.disguise.one/api/guides/working-with-sessions): Managing Designer sessions via the API

### Service Endpoints
- [Project](https://developer.disguise.one/api/service/project)
- [System](https://developer.disguise.one/api/service/system)
- [Media](https://developer.disguise.one/api/service/media-reference)
- [Tasks](https://developer.disguise.one/api/service/tasks)

### Session Endpoints
- [Transport](https://developer.disguise.one/api/session/transport)
- [Sequencing](https://developer.disguise.one/api/session/sequencing)
- [RenderStream](https://developer.disguise.one/api/session/renderstream)
- [Live Update](https://developer.disguise.one/api/session/liveupdate)
- [Mixed Reality](https://developer.disguise.one/api/session/mixedreality)
- [Colour](https://developer.disguise.one/api/session/colour)
- [Notes](https://developer.disguise.one/api/session/notes)
- [Status](https://developer.disguise.one/api/session/status)
- [Sockpuppet](https://developer.disguise.one/api/session/sockpuppet)
- [QuickCal](https://developer.disguise.one/api/session/quickcal)
- [Failover](https://developer.disguise.one/api/session/failover)
- [Shot Recorder](https://developer.disguise.one/api/session/shotrecorder)
- [Looks](https://developer.disguise.one/api/session/looks): List Looks with their exposed fields, values and metadata
- [OmniCal](https://developer.disguise.one/api/session/omnical): Control the OmniCal RigCheck workflow
- [Python](https://developer.disguise.one/api/session/python): Execute Python and register modules through the REST API

## Python API

Execute Python code in Designer sessions to control and query projects programmatically.

- [Overview](https://developer.disguise.one/python-api/introduction): Introduction to the Python API
- [Execution API](https://developer.disguise.one/python-api/execution-api): REST endpoint for executing Python code
- [Environment](https://developer.disguise.one/python-api/environment): Runtime environment, utilities, and restrictions
- [Python Reference](https://developer.disguise.one/python-api/docs): Full auto-generated d3 Python API reference
- [Useful Python Strings](https://developer.disguise.one/python-api/useful-strings): Common code snippets for quick tasks
- [API Changes](https://developer.disguise.one/python-api/api-changes): Changelog across Designer versions

### Python API Guides
- [Audio](https://developer.disguise.one/python-api/guides/audio)
- [Calibration](https://developer.disguise.one/python-api/guides/calibration)
- [D3Net](https://developer.disguise.one/python-api/guides/d3net)
- [Devices](https://developer.disguise.one/python-api/guides/devices)
- [Expressions](https://developer.disguise.one/python-api/guides/expressions)
- [Feed](https://developer.disguise.one/python-api/guides/feed)
- [Resources](https://developer.disguise.one/python-api/guides/resources)
- [Stage](https://developer.disguise.one/python-api/guides/stage)
- [Track and Sequencing](https://developer.disguise.one/python-api/guides/track-and-sequencing)
- [Transports](https://developer.disguise.one/python-api/guides/transports)
- [Utility](https://developer.disguise.one/python-api/guides/utility)
- [Video Input](https://developer.disguise.one/python-api/guides/video-input)

## Designer Plugins

HTML plugin system for extending Disguise Designer with custom UIs.

- [Overview](https://developer.disguise.one/plugins/introduction): Introduction to the plugin system
- [Getting Started](https://developer.disguise.one/plugins/getting-started): Creating your first plugin
- [Architecture](https://developer.disguise.one/plugins/architecture): Internal vs remote plugins
- [Configuration](https://developer.disguise.one/plugins/configuration): Discovery, metadata, and styling
- [Distribution](https://developer.disguise.one/plugins/distribution): Sharing and distributing plugins
- [Tools & Libraries](https://developer.disguise.one/plugins/useful-links): Official libraries and developer tools
- [Accessing d3 Projects](https://developer.disguise.one/plugins/d3projects-access): Locate project files with DNS-SD discovery and the Projects API

### designer-plugin Python library
Install with `pip install designer-plugin` (type stubs: `pip install designer-plugin-pystub`).
- [Overview](https://developer.disguise.one/plugins/designer-plugin/designer-plugin): Install and use the designer-plugin library
- [Client API](https://developer.disguise.one/plugins/designer-plugin/client-api): D3PluginClient class-based remote execution
- [Functional API](https://developer.disguise.one/plugins/designer-plugin/functional-api): Decorator-based remote execution with @d3function
- [Publish](https://developer.disguise.one/plugins/designer-plugin/publish): Publish a plugin with designer-plugin
- [Reference](https://developer.disguise.one/plugins/designer-plugin/reference): designer-plugin API reference

## RenderStream SDK

- [Overview](https://developer.disguise.one/renderstream/introduction): RenderStream SDK for real-time rendering integration

## Data Formats

- [Overview](https://developer.disguise.one/formats/introduction): Data format specifications
- [2.5D Assets](https://developer.disguise.one/formats/2p5d): 2.5D asset format

## SMC API

REST API for Disguise System Management Controller hardware.

- [Introduction](https://developer.disguise.one/smc/introduction): Overview of the SMC API
- [OpenAPI Specs](https://developer.disguise.one/smc/openapi): Download SMC OpenAPI specifications

### SMC Endpoints
- [SMC](https://developer.disguise.one/smc/api/smc)
- [Chassis](https://developer.disguise.one/smc/api/chassis)
- [Local Machine](https://developer.disguise.one/smc/api/machine)
- [Network Adapters](https://developer.disguise.one/smc/api/adapters)
- [LED Strip](https://developer.disguise.one/smc/api/ledstrip)
- [OLED](https://developer.disguise.one/smc/api/oled)
- [Session](https://developer.disguise.one/smc/api/session)
- [VFCs](https://developer.disguise.one/smc/api/vfc)

## Cloud API

REST API for Disguise Cloud services.

- [Introduction](https://developer.disguise.one/cloud/introduction): Overview of the Cloud API
- [Authentication](https://developer.disguise.one/cloud/authentication): API authentication and tokens
- [Pagination](https://developer.disguise.one/cloud/pagination)
- [Rate Limits](https://developer.disguise.one/cloud/rate-limits)
- [Error Handling](https://developer.disguise.one/cloud/error-handling)

### Management API
- [Overview](https://developer.disguise.one/cloud/management/overview)
- [Organisations](https://developer.disguise.one/cloud/management/organisations)
- [Drives](https://developer.disguise.one/cloud/management/drives)
- [Archive Drive](https://developer.disguise.one/cloud/management/drive-archive)
- [Restore Drive](https://developer.disguise.one/cloud/management/drive-restore)
- [Self](https://developer.disguise.one/cloud/management/self)

### Drive API
- [Overview](https://developer.disguise.one/cloud/drive/overview)
- [Folders](https://developer.disguise.one/cloud/drive/folders)
- [Content](https://developer.disguise.one/cloud/drive/content)
- [Create Folder](https://developer.disguise.one/cloud/drive/create-folder)
- [Create Asset](https://developer.disguise.one/cloud/drive/create-asset)
- [Request Upload](https://developer.disguise.one/cloud/drive/request-upload)
- [Create Version](https://developer.disguise.one/cloud/drive/create-version)
- [Versions](https://developer.disguise.one/cloud/drive/versions)
- [Self](https://developer.disguise.one/cloud/drive/self)

## Machine-Readable Resources

- [Service API OpenAPI Spec (JSON)](https://developer.disguise.one/specs/service.swagger.json)
- [Session API OpenAPI Spec (JSON)](https://developer.disguise.one/specs/session.swagger.json)
- [SMC API OpenAPI Spec (JSON)](https://developer.disguise.one/specs/smc.swagger.json)
- [d3 Python Type Stubs (d3.pyi)](https://developer.disguise.one/assets/d3.pyi)
- [Full documentation as Markdown (llms-full.txt)](https://developer.disguise.one/llms-full.txt)
- [Sitemap](https://developer.disguise.one/sitemap-index.xml)

## Contact

- Website: https://disguise.one
- GitHub: https://github.com/disguise-one