PhotoMesh API

PhotoMesh provides a REST API for PM Production to automate the production phases, e.g., load photo files or list, set AT and reconstruction areas, begin and manage a build, and create new build versions.

To explore interactive documentation of the PhotoMesh REST API:

• From the Start page, open the Automation Dashboard and in the PhotoMesh API section, click Reference Guide, or click here.

Swagger Tutorial: Creating a Simple Build with the PhotoMesh REST API

This step-by-step guide (including sample data) demonstrates how to use Swagger to create a simple build using the PhotoMesh REST API. Note that it is important to allow PhotoMesh to fully process each request before moving to the next step.

• Step 1: Set up your project
• Step 2: Create a new project using the PhotoMesh API in Swagger
• Step 3: Load photos into the project
• Step 4: Start the build:

Step 1: Set up your project

1. Download this example project, extract its files and save them in the following folder: C:\MyProject.
   Note:  This example project is used in several other PhotoMesh tutorials, including: the Project Queue API tutorial and General Tutorial.  Some files and folders in this project are specific to those tutorials and will not be used in this one.
2. From PhotoMesh's Start page, open the Automation Dashboard and in the PhotoMesh API section, click Reference Guide. Swagger opens showing PM_API.
   

Step 2: Create a new project 

1. Expand the ProjectApi section, and click /Project/New/{PhotomeshXmlPath}
   
   
2. Click Try it out.
3. In the PhotomeshXmlPath box, type the following:

   C:\MyProject\MyProject.PhotoMeshXML

4. Click Execute. A new project named "MyProject.PhotoMeshXML" opens in PhotoMesh.
   

Step 3: Load photos into the project

1. In the ProjectApi section, click /Project/LoadPhotosList/{photoListPath}
   
   
2. Click Try it out.
3. In the photoListPath box, type the following:

   C:\MyProject\Photos\Frederick.xlsx

4. Click Execute. The photos referenced in the Frederick.xlsx file are loaded into your PhotoMesh project.
   

Step 4: Start the build:

1. In the ProjectApi section, click /Project/Build/{PresetsFile}
   
   
2. Click Try it out.
3. In the PresetFile box, type the following:

   PhotoMesh default

4. Click Execute. PhotoMesh Build Manager opens, fusers activate automatically, and the build process begins.
   

Exploring Further

Use the Swagger interface to explore and experiment with other API functions.