Skip to content

Commit 755a296

Browse files
committed
docs: added public instance
1 parent fc3f4b5 commit 755a296

File tree

2 files changed

+27
-0
lines changed

2 files changed

+27
-0
lines changed
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Public Instance
2+
3+
## Try the Voiceflow CLI Server Online
4+
5+
If you want to try out the Voiceflow CLI server without setting it up locally, you can use our public instance:
6+
7+
**Base URL:** https://voiceflow-cli-api.xavidop.me/
8+
9+
## Interactive API Documentation
10+
11+
You can explore and test the API endpoints directly in your browser using our Swagger playground:
12+
13+
**Swagger UI:** https://voiceflow-cli-api.xavidop.me/swagger/index.html
14+
15+
The Swagger interface allows you to:
16+
- View all available API endpoints
17+
- See request/response schemas
18+
- Test API calls directly from your browser
19+
- Download API specifications
20+
21+
## Getting Started
22+
23+
1. Visit the [Swagger playground](https://voiceflow-cli-api.xavidop.me/swagger/index.html)
24+
2. Explore the available endpoints
25+
3. Try out the API calls with your own data
26+
4. Use the examples from the [usage examples](usage-examples.md) by replacing `http://localhost:8080` with `https://voiceflow-cli-api.xavidop.me`

docs/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ nav:
132132
- API Endpoints: server/api-endpoints.md
133133
- Usage Examples: server/usage-examples.md
134134
- Security & Troubleshooting: server/security-troubleshooting.md
135+
- Public Instance: server/public-instance.md
135136
- Command Line Usage:
136137
- voiceflow: cmd/voiceflow.md
137138
- voiceflow test: cmd/voiceflow_test.md

0 commit comments

Comments
 (0)