Skip to main content

​
Overview

The ingress service is the WebSocket endpoint your server connects to in order to send audio and receive animation frames. There are currently two ingress API versions with different endpoint URL paths: v1 and v2.

​
Endpoint URL formats

Use your selected <region> (see Regions):
  • Ingress v2 (recommended): https://api.<region>.spatialwalk.cloud/v2/driveningress
  • Ingress v1 (deprecated): https://api.<region>.spatialwalk.cloud/v1/driveningress

​
SDK compatibility

SDKIngress API supported
Golang SDKv1 only
Python SDKv2 only

​
Deprecation policy

  • Ingress v1 is deprecated and will be removed in the future.
  • We are in rapid iteration: v2 SDKs for Go and other languages will be available soon.

​
What you should do

  • New integrations: use Ingress v2.
  • Existing Golang integrations: continue with Ingress v1 for now, and plan to migrate to v2 when the Golang v2 SDK is released.