Get Your API Key
Create an API Key
Navigate to Settings > API Keys and create a new key
Save Your Key
Copy your API key - you won’t be able to see it again
Make Your First Request
Let’s discover available tours:
curl -X GET "https://api.nvrse.dev/api/interactive/templates/public" \
-H "X-API-Key: your_api_key_here"
Start a Tour
Once you’ve found a template, start a run:
curl -X POST "https://api.nvrse.dev/api/interactive/runs/start" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"adventureId": "template-uuid-here"}'
run - The run object with ID and statecurrentNode - The first node with AI-enriched content
Navigate Through Nodes
Progress to the next node:
curl -X PATCH "https://api.nvrse.dev/api/interactive/runs/{runId}/progress" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{"nextNodeId": "next-node-uuid"}'
Chat with the AI Guide
Users can ask questions at any node:
curl -X POST "https://api.nvrse.dev/api/interactive/chat" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"runId": "run-uuid",
"nodeId": "node-uuid",
"message": "Tell me more about this place"
}'
The chat endpoint returns a streaming text response, not JSON. Handle it as a stream for real-time display.
Complete the Tour
When the user finishes:
curl -X POST "https://api.nvrse.dev/api/interactive/runs/{runId}/complete" \
-H "X-API-Key: your_api_key_here"
Next Steps
