Skip to content

API Overview

The PromptJang API is RESTful, uses JSON for request/response bodies, and supports two authentication methods.

Base URL

https://api.promptjang.net

Authentication

All endpoints (except health) require authentication via either method:

Authorization: Bearer pj_live_YOUR_API_KEY

or

X-Session-Token: your-session-token

See 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):

7a337feef0633bcfa20ae1b0ba3e0372

Delivery attempt IDs have a da_ prefix:

da_7a337feef0633bcfa20ae1b0ba3e0372

Timestamps

All timestamps are ISO 8601 (RFC 3339):

2026-05-26T12:00:00Z

Pagination

List endpoints support limit and offset query parameters:

GET /api/v1/events?limit=50&offset=100

Default 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-referrer

Error Responses

All errors follow the format:

json
{
  "error": "Human-readable error message"
}

See Error Codes for the full reference.

Endpoints Summary

MethodPathDescription
GET/healthHealth check
Auth
POST/api/v1/auth/signupCreate account
POST/api/v1/auth/loginLogin
POST/api/v1/auth/logoutLogout (current session)
POST/api/v1/auth/logout-allRevoke all sessions
GET/api/v1/auth/meGet current user
Ingest
POST/e/:endpoint_idIngest event
Organizations
GET/api/v1/orgsGet organization
PATCH/api/v1/orgsUpdate organization
Endpoints
GET/api/v1/endpointsList endpoints
POST/api/v1/endpointsCreate endpoint
GET/api/v1/endpoints/:idGet endpoint
PATCH/api/v1/endpoints/:idUpdate endpoint
DELETE/api/v1/endpoints/:idDelete endpoint
API Keys
GET/api/v1/keysList API keys
POST/api/v1/keysCreate API key
DELETE/api/v1/keys/:idDelete API key
Events
GET/api/v1/eventsList events
GET/api/v1/events/:idGet event
POST/api/v1/events/:id/replayReplay event
Stats
GET/api/v1/statsDelivery statistics
Billing
POST/api/v1/billing/checkoutStripe checkout
GET/api/v1/billing/portalStripe portal

Released under the MIT License.