Authentication
Authenticate requests with a secret API key using the Authorization bearer header.
The Palmframe API authenticates requests with API keys. Each key is scoped to a single publication and carries the same permissions as your account for that publication.
API key format
Live keys are prefixed so they are easy to recognize in logs and code:
pf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6Treat API keys like passwords. They grant full access to your publication — never commit them to source control, embed them in client-side code, or share them in screenshots.
Authenticating a request
Send your key as a bearer token in the Authorization header:
Authorization: Bearer pf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6Here is a complete request against GET /me, which returns the publication
context the key belongs to:
curl https://palmframe.com/api/v1/me \
-H "Authorization: Bearer pf_live_a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"{
"object": "api_key_context",
"key_id": "key_9f8e7d6c",
"scopes": [],
"publication": {
"object": "publication",
"id": "pub_9f8e7d6c",
"title": "The Weekly Frame",
"slug": "weekly-frame",
"description": "A newsletter about building in public.",
"logo_url": "https://palmframe.com/logos/weekly-frame.png",
"sender_name": "Alexis",
"reply_to": "hello@weekly-frame.com",
"url": "https://weekly-frame.palmframe.com",
"created_at": "2026-01-04T12:00:00.000Z",
"updated_at": "2026-07-10T08:15:00.000Z"
}
}A missing, malformed, or revoked key returns
401 unauthorized.
Creating and revoking keys
API keys are managed in the dashboard under Settings → API keys.
- Open Settings → API keys.
- Click Create key, give it a name, and confirm.
- Copy the key immediately. For security, the full key is shown only once at creation time — Palmframe stores only a hash of the key, so it can never display the secret again. If you lose it, revoke the key and create a new one.
- To disable a key, click Revoke next to it. Revocation is immediate; any
request using that key afterwards returns
401 unauthorized.
Keys are hashed at rest
Palmframe never stores your raw API key. Only a one-way hash is kept, which is why the plaintext key is displayed a single time. Keep a copy in your secrets manager the moment you create it.