/createTour
POST https://api.voxtour.ai/v1/createTour
createTour API allows users to generate a customized tour from an existing template. Users can define storytelling preferences, select a voice assistant, and tailor the experience based on audience demographics and thematic focus.
Key Features
- Create a personalized tour using a predefined template
- Customize storytelling style with adjustable parameters
- Choose a voice assistant for narration
- Define a unique tour theme and focus
Example Request
Creating a tour with custom storytelling settings:
{
"apiKey": "12345678-90ab-cdef-1234-567890abcdef",
"tourTemplateId": "6e72952b-e987-4b5c-9f05-b568d622bdbf",
"voiceAssistant": "William",
"averageAge": 40,
"storytellingControls": {
"Formality": 4,
"ToneOfVoice": 4,
"ComplexityLevel": 3,
"EmpathyLevel": 1,
"ImaginationLevel": 1,
"DetailLevel": 4,
"CulturalSensitivity": 1,
"OptimismPessimism": 3,
"LanguageStyle": 3
},
"tourTheme": "This tour focuses on Modern Toronto, showcasing the ..."
}
Request Body
apiKey string Required
A unique authentication key required for API access. This key must be included in every request to authorize and validate usage.
tourTemplateId string Required
The unique identifier of the tour template from which the new tour will be created.
voiceAssistant string Optional
The name of the voice assistant that will narrate the tour.
averageAge integer Optional
The estimated average age of the tour audience, influencing storytelling complexity.
storytellingControls object Optional
A set of parameters controlling the storytelling style, including formality, tone of voice, complexity level, and cultural sensitivity.
tourTheme string Optional
A brief description of the tour's theme, such as historical, cultural, or modern architecture.
Example Response
Returns a unique identifier for the newly created tour:
{
"tourId": "a7b1ac9d-3f64-4bd5-ad84-5cf59a72045b"
}