REST API Overview
Monitor-first endpoints, authentication, rate limits, and compatibility APIs.
The REST API is available on Pro, Team, and Enterprise. The primary workflow is to create a Monitor, ingest traffic, and start or retrieve comparison Runs.
Base URL and authentication
https://app.peerlm.com/api/v1X-API-Key: <YOUR_PEERLM_API_KEY>
# or
Authorization: Bearer <YOUR_PEERLM_API_KEY>Create a key in Settings > API Keys. Read keys can retrieve Monitors, Runs, models, and usage. Read-write keys can also create Monitors, ingest traffic, start Runs, and invoke Prompt CI. Secrets use the plm_live_ prefix, are shown once, and are stored only as SHA-256 hashes.
Primary endpoints
| Purpose | Endpoints |
|---|---|
| Monitors | GET/POST /workloads |
| Traffic | POST /ingest, POST /otel |
| Comparison Runs | GET/POST /audits, GET /audits/:id |
| Prompt CI | POST /deploys |
| Catalog and capacity | GET /models, GET /usage |
The API uses internal resource names for backward compatibility:workload means Monitor and audit means comparison Run.
Compatibility endpoints
/suites, /runs, /system-prompts, and /test-prompts remain for existing authored-evaluation integrations and the internal comparison engine. They do not correspond to customer dashboard screens and should not be used for a new Monitor integration.
Rate limits and errors
Authentication allows 200 requests per minute per key. Creating an authored evaluation Run or Monitor Run is additionally limited to 10 requests per 60 seconds; Prompt CI allows 20 per 60 seconds. A 429 response includes Retry-After. All errors return JSON with an error field.