Interactive API Explorer

Test API endpoints directly from your browser with the Swagger UI interactive documentation. Explore request/response schemas, authentication, and try live API calls.

OpenAPI Specification

Vertaa API v1 (2025-01-10)

View Raw Spec Download Postman

🚧 Coming Soon: Full Interactive Explorer

We're implementing a full Swagger UI integration for interactive API testing. In the meantime:

View the raw OpenAPI spec
Use Swagger Editor with our spec
Import into Postman (see Postman Collection below)
Follow our Developer Docs for cURL examples

Quick Start

1. Get your API key

Generate an API key from your dashboard

2. Test with cURL

curl -X POST https://vertaaux.ai/v1/audit \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com", "mode": "basic"}'

3. Check result

curl -X GET https://vertaaux.ai/v1/audit/{job_id} \
  -H "X-API-Key: YOUR_API_KEY"

Postman Collection

Import our official Postman collection for quick testing

Coming Soon

Generate Collection from OpenAPI

Download OpenAPI spec
Open Postman → Import → Select OpenAPI 3.0 file
Configure environment variables:
- base_url: https://vertaaux.ai/v1
- api_key: Your API key from dashboard
Start testing endpoints

Tip: Use Postman's Collection Runner to execute multiple audit requests in sequence with different URLs.