Virtual tours

Get a virtual tour (poll this)

Returns the tour's status (processing | ready | failed) and, when ready, its scenes, navigation links and display settings. Poll it after create_virtual_tour and add_virtual_tour_scenes. Free.

post/api/get_virtual_tour

Request

  • Base URL: https://app.pedra.ai
  • URL: https://app.pedra.ai/api/get_virtual_tour
  • Auth: none required

Request body

apiKeystring required

Account API key, sent in the request body. Get one at https://app.pedra.ai under Settings → API.

tourIdstring required

Response

The tour.

tourIdstring
propertyIdstring
namestring nullable
status'processing' | 'ready' | 'failed'
tourUrlstring

Public tour page. Stable across edits.

embedCodestring

Ready-to-paste <iframe> for the tour.

appUrlstring nullable

The property in the Pedra app.

shareableboolean

false on free-plan accounts: the tour builds, but its public link shows an upgrade page.

shareableNotestring

Present when shareable is false.

sceneCountinteger
linkCountinteger
coverImageUrlstring nullable
createdAtstring date-time
updatedAtstring date-time
errorstring

Present when status is failed.

lastErrorstring

Present on a ready tour whose last add_virtual_tour_scenes failed.

Changes

No recorded changes to this operation across all 1 revision of this API.