API Basics
The Reality Capture API provides a set of endpoints for the Photo to 3D capability. These endpoints allow you to manage the process of generating a 3D mesh from overlapping photos. The main entities of the API are as follows:
Entity | Definition |
---|---|
File | An image or other file-based resource used for photogrammetry processing usage |
Files | A collection of one or more File entities |
Photoscene | A lightweight project that groups images, processing metadata, and other settings for photogrammetry processing usage |
Photoscenes | A collection of one or more Photoscene entities |
Service | Provides information pertaining to the Web API server and dependent services |
API Cost
Usage of the Reality Capture API is billed by consumption based on the type of Reality Capture API functionality requested and the input/payload provided; this ensures a granular ‘pay-as-you-go’ tiered-cost structure at a competitive price. Consolidated billing reports can be viewed from the APS developer portal interface these reports provide a high-level overview of billable usage generated by your end users.
Typical Photo to 3D Workflow
There are many different ways to use the Photo to 3D capability, however, the following is a typical workflow:
- Capture images of the physical world: These are a set of overlapping images, captured at multiple heights, representing an object or site.
- Authenticate with the Reality Capture API: A third party application linked to the Reality Capture API authenticates its users.
- Upload images externally: Upload captured images to your own HTTPS-accessible cloud location (Amazon S3).
- Create project: Generate a new Photoscene, specify its processing options, and other properties.
- Associate images with project: Refer to existing image URL links (or upload captured images directly).
- Process project: Request that captured images be stitched and that a 3D mesh be generated.
- Poll for project status: Request updates on project processing progress.
- Accept callback notification on project completion: Receive a notification via email and/or HTTP/HTTPS callback once a project has finished processing.
- Review/download processed output: Request links to processed output. View generated 3D preview mesh and ortho image via mobile (remotely) via ReCap 360 Dashboard and other Autodesk Platform Services.
Check out the Step-by-Step tutorials to see how to create a Photoscene, associate images to that Photoscene, and generate a corresponding 3D mesh.