Skip to main content

Documentation Index

Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Welcome to the Promptwatch API documentation. This documentation provides comprehensive guides and reference for integrating with the Promptwatch monitoring platform.

​
What is Promptwatch?

Promptwatch is a monitoring platform that helps you track and analyze how Large Language Models (LLMs) respond to queries, monitor your brand visibility, analyze citations, and gain insights into AI-powered search results.

​
API Versions

We currently support two API versions:
  • API v2 (Beta) - Current recommended API with comprehensive features.
  • API v1 - Legacy API

​
Quick Start

  1. Get Your API Key: Navigate to Settings > API Keys in your Promptwatch dashboard
  2. Choose Your Version: Use v2 for new integrations
  3. Start Integrating: Use the interactive API documentation to explore endpoints

​
Authentication

All API requests require authentication using an API key. Include your API key in the X-API-Key header: 
curl -X GET "https://server.promptwatch.com/api/v2/models" \
  -H "X-API-Key: your-api-key-here"

​
Postman Collection

We provide a comprehensive Postman collection with pre-configured requests for all API endpoints:

Postman Collection Available

Import our pre-configured collection into Postman to quickly test all API endpoints

​
How to Use the Postman Collection

  1. Download the Postman Collection
  2. Import into Postman (File → Import)
  3. Configure the collection variables:
    • apiKey: Your API key from the Promptwatch dashboard
    • projectId: Your project UUID (required for organization-level keys, can be fetched via the GET /projects endpoint)
    • baseUrl: Set to https://server.promptwatch.com (defaults to localhost)
  4. Start Testing: All requests are pre-configured with proper headers and authentication

​
Next Steps

​
Support

Need help? Contact us at team@promptwatch.com or visit promptwatch.com.