Virtual tours

Update a virtual tour

Renames the tour or its rooms, reorders or removes rooms, replaces all navigation links, and changes the navigation point style. Free and instant; validation is all-or-nothing. Returns the full tour. 409 tour_processing while the tour is building.

post/api/update_virtual_tour

Request

  • Base URL: https://app.pedra.ai
  • URL: https://app.pedra.ai/api/update_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
namestring
sceneNamesobject

Room names by sceneId.

sceneOrderstring[]

Every sceneId exactly once; the first is where the tour opens.

removeScenesstring[]

sceneIds to remove. Photos stay in the property; links touching them are dropped; at least one scene must remain.

navigationStyle'white' | 'blue'
navigationSize'small' | 'medium' | 'large'
showLabelsboolean

Always show room-name labels on navigation points.

language'en' | 'es' | 'fr' | 'de' | 'it' | 'pt'

Tour page UI language and the language of AI room names. Non-English tours get a /{lang}/virtual-tour/... URL.

Response

The updated 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.