API v1 (legacy) is not recommended for use. New integrations should use API v2. V1 will continue to work but won’t receive new features.
API v1 provides read-only access to your Promptwatch monitoring data. For full CRUD operations and new features, migrate to v2.
What’s Included
- Authentication - Validate API keys
- Models - List available LLM models
- Monitors - List monitors (read-only)
- Prompts - List and get prompts (read-only)
- Visibility - Track visibility metrics over time
- Citations - Analyze citation sources and domains
- Analytics - Visitor and crawler analytics
- Share of Voice - Brand mention analytics
- Responses - Response analytics with sentiment
- Brands - Brand visibility analytics
Base URL
https://server.promptwatch.com/api/v1
Authentication
Include your API key in the X-API-Key header:
curl -X GET "https://server.promptwatch.com/api/v1/models" \
-H "X-API-Key: your-api-key"
For organization-level keys accessing a specific project:
curl -X GET "https://server.promptwatch.com/api/v1/monitors" \
-H "X-API-Key: your-org-api-key" \
-H "X-Project-Id: your-project-uuid"
Migrating to v2
Migration is straightforward:
- Update base URL from
/api/v1 to /api/v2
- Authentication headers remain the same
- Most endpoints have the same structure
- v2 adds CRUD operations for monitors, prompts, tags, and projects
Support