RealityConnect API (RCAPI)

Introduction Overview of the Prevu3D RealityConnect API: capabilities, regional architecture, OAuth2 authentication, and how it fits into RealityPlatform and RealityTwin integrations.

Getting Started Prerequisites, network access, and the security model for the RealityConnect API. Choose an OAuth flow and follow its dedicated guide.

Your First Change, End to End A copy-paste Client Credentials walkthrough: get a token, browse to a site, rename it, see the change in the Prevu3D Platform, then undo it.

OAuth Scopes Reference Every OAuth scope the RealityConnect API grants, what it authorizes, and the gotchas that trip up new integrations.

Searching Business Objects and Nodes Search inside a twin's business objects and metadata, or search your organization's node hierarchy, through the RealityConnect API.

OAuth flows Client Credentials Flow, Native Application Flow, Authorization Code + Custom Redirect Flow

Rate Limits RealityConnect API rate limit buckets, response headers, and how to handle 429 Too Many Requests.

Error Codes Reference for the named error codes RealityConnect API operations return, grouped by endpoint, with the response shape and suggested handling for each.

What contextId Accepts What id types the contextId path parameter accepts on RealityConnect API twin and RealityPlan routes, and why a valid id of the wrong kind returns 404.

Token Lifecycle in Practice How to cache and refresh a RealityConnect API OAuth token safely over a long-running integration: real TTLs per flow and what invalidates a token early.

Handling Credentials How to store, rotate, and revoke RealityConnect API OAuth credentials safely, and what a leaked access token can reach.

What Delete Actually Does, Per Resource Reference for what deleting each RealityConnect API resource does: which deletes are recoverable, what blocks them, and what happens to references left behind.

Node Types and Hierarchy The 10 RealityConnect API node types, which parent/child combinations are valid, which types the API can create, and the DataNode shape.

API Stability, Versioning, and Deprecation How the RealityConnect API marks experimental operations, what counts as a breaking change, and the deprecation policy.

POI Icon Reference (textureId) The full set of valid textureId values for creating a point of interest (POI), and what each icon actually depicts.

Finding Your IDs: Organizations, Nodes, and Context Discover your organization id, walk the RealityConnect API's node tree, and learn which id each route family (contextId, organizationId) expects.

Shared Multipart Upload Reference The initiate, upload, and finalize pattern shared by RealityConnect API upload endpoints, including the partNumber vs startIndex part-numbering rule.

Typed Metadata Values and Attachments Reference for RealityConnect API metadata property values: the string/number/boolean/tagged-object union, external-link and attachment sentinel types, and the attachment upload, download, and delete flow.

Node Thumbnails Upload, retrieve, and remove a data node's thumbnail image, and how includeThumbnail and thumbnailSignedUrl behave on browse and search.

Network Requirements Firewall, proxy, TLS, and egress requirements for reaching the RealityConnect API from inside a corporate network, plus a step-by-step connectivity diagnosis.

RealityConnect API FAQ Answers to the commercial, architectural, and 'can I do this' questions about the RealityConnect API that come up before a project is approved.