API Playground
Test API endpoints directly in the documentation
API Playground
Try the VertaaUX API without leaving the documentation. This interactive playground lets you make real API requests.
API Key Required: You need a valid API key to make requests. Get one from your account settings.
Your API key is stored in your browser session only and is never sent to our servers (except for the actual API calls).
Try Requests Live
The playground below lets you select an endpoint, fill in parameters, and execute requests against the live API.
Desktop Only: The interactive playground works best on desktop. On mobile, see the static API Reference instead.
Available Endpoints
- POST /v1/audit - Create a new UX audit
- GET /v1/audit/{job_id} - Get audit status and results
- GET /v1/quota - Check your usage quota
- POST /v1/webhooks - Create a webhook endpoint
- GET /v1/webhooks - List your webhooks
See the full API reference for detailed documentation.
Tips
- Use test API keys (
vx_test_...) to avoid consuming your quota - The playground shows response data in JSON format
- Request history is not persisted between sessions
Related
Authentication
Learn about API key formats and authentication methods
Error Handling
Understand error codes and how to handle them
Was this page helpful?