Skip to main content

API Documentation

Integrate RoastMyPage into your workflow with our API.

Authentication

All API requests require an API key passed via the Authorization header.

Authorization: Bearer your_api_key

Get your API key from Settings (requires a Pro plan).

POST

/api/roast

Submit a URL for roasting. Returns a roast ID that can be used to retrieve the results.

Request Body

{
  "url": "https://example.com"
}

Response

{
  "id": "roast_abc123",
  "status": "processing"
}
GET

/api/roast/:id

Retrieve the results of a completed roast.

Response

{
  "id": "roast_abc123",
  "url": "https://example.com",
  "score": 42,
  "roast": "Your hero section...",
  "suggestions": ["..."],
  "created_at": "2026-04-17T12:00:00Z"
}

Rate Limits

Free tier 3 roasts / day
Pro plan 50 roasts / day
API access Pro plan required