API Overview
The PromptJang API is RESTful, uses JSON for request/response bodies, and supports two authentication methods.
Base URL
https://api.promptjang.netAuthentication
All endpoints (except health) require authentication via either method:
Authorization: Bearer pj_live_YOUR_API_KEYor
X-Session-Token: your-session-tokenSee Authentication for details.
Content Type
All request bodies must be application/json. All responses are application/json.
CORS
The API allows cross-origin requests from https://app.promptjang.net only. Preflight OPTIONS requests are handled automatically.
Allowed headers: Authorization, X-Session-Token, Content-Type, X-Requested-With.
Common Patterns
IDs
All resource IDs are 32-character hex strings (128-bit crypto-random):
7a337feef0633bcfa20ae1b0ba3e0372Delivery attempt IDs have a da_ prefix:
da_7a337feef0633bcfa20ae1b0ba3e0372Timestamps
All timestamps are ISO 8601 (RFC 3339):
2026-05-26T12:00:00ZPagination
List endpoints support limit and offset query parameters:
GET /api/v1/events?limit=50&offset=100Default limit: 50. Maximum limit: 100.
Security Headers
All responses include:
Content-Security-Policy: default-src 'none'
Strict-Transport-Security: max-age=63072000; includeSubDomains; preload
X-Content-Type-Options: nosniff
X-Frame-Options: DENY
Cache-Control: no-store
Referrer-Policy: no-referrerError Responses
All errors follow the format:
{
"error": "Human-readable error message"
}See Error Codes for the full reference.
Endpoints Summary
| Method | Path | Description |
|---|---|---|
GET | /health | Health check |
| Auth | ||
POST | /api/v1/auth/signup | Create account |
POST | /api/v1/auth/login | Login |
POST | /api/v1/auth/logout | Logout (current session) |
POST | /api/v1/auth/logout-all | Revoke all sessions |
GET | /api/v1/auth/me | Get current user |
| Ingest | ||
POST | /e/:endpoint_id | Ingest event |
| Organizations | ||
GET | /api/v1/orgs | Get organization |
PATCH | /api/v1/orgs | Update organization |
| Endpoints | ||
GET | /api/v1/endpoints | List endpoints |
POST | /api/v1/endpoints | Create endpoint |
GET | /api/v1/endpoints/:id | Get endpoint |
PATCH | /api/v1/endpoints/:id | Update endpoint |
DELETE | /api/v1/endpoints/:id | Delete endpoint |
| API Keys | ||
GET | /api/v1/keys | List API keys |
POST | /api/v1/keys | Create API key |
DELETE | /api/v1/keys/:id | Delete API key |
| Events | ||
GET | /api/v1/events | List events |
GET | /api/v1/events/:id | Get event |
POST | /api/v1/events/:id/replay | Replay event |
| Stats | ||
GET | /api/v1/stats | Delivery statistics |
| Billing | ||
POST | /api/v1/billing/checkout | Stripe checkout |
GET | /api/v1/billing/portal | Stripe portal |