Using the Preimage API
Preimage provides GraphQL and REST APIs for developers and integrators. Use GraphQL to query related workspace data and retrieve output locations. Use REST v2 for resource-based workflows such as managing projects and scans.
The API supports common use cases like:
- Listing projects and scans in your workspace
- Checking the processing status of scan outputs
- Fetching output locations (point clouds, virtual tours, 3D models)
- Reading inputs, files, annotations, and metadata
GraphQL uses a workspace API key in the x-api-key header. REST v2 uses a bearer token in the Authorization header. These credentials are different; contact Preimage for REST access and token setup.
Access the API Documentation
Start with the API overview to choose an API and understand authentication.