API Documentation

Integrate FadeKey into your apps and pipelines. Secrets that expire by design.

Quickstart

Create and read a secret in under 60 seconds. Pick your language:

# 1. Criar um secret
curl -X POST https://api.fadekey.app/api/items \
  -H "X-API-Key: fk_live_SUA_CHAVE" \
  -H "Content-Type: application/json" \
  -d '{"ciphertext":"BASE64_CONTEUDO","iv":"BASE64_IV","ttl":3600,"maxViews":1}'

# Resposta:
# { "id": "uuid", "expiresAt": "2026-05-28T..." }

# 2. Ler o secret (consome 1 view)
curl https://api.fadekey.app/api/items/UUID_DO_SECRET \
  -H "X-API-Key: fk_live_SUA_CHAVE"

Authentication

Authenticate by passing your API key in the X-API-Key header or as a Bearer token.

X-API-Key: fk_live_xxxxxxxxxxxxxxxx
# ou
Authorization: Bearer fk_live_xxxxxxxxxxxxxxxx

Generate your API key in the dashboard under API Keys. Keep it secret — treat it like a password.

Playground

Try the API live, right here. No setup needed for anonymous requests.

API Key (optional)

Payload (the content to protect)22 / 500

TTL (segundos) (60 - 86400)

Max views (1 - 3)

Endpoints

POST/api/items

Create a new secret. Returns an ID and expiration date.

Campo	Tipo	Obrigatório	Descrição
`ciphertext`	string	✓	Base64-encoded content (encrypt client-side before sending).
`iv`	string	✓	Base64-encoded initialization vector used during encryption.
`ttl`	number	✓	Time-to-live in seconds (min 60, max 604800 for Pro).
`maxViews`	number		Maximum number of reads before the secret is destroyed.
`passwordHash`	string		Optional SHA-256 hash of a passphrase to protect access.

GET/api/items/:id

Retrieve and decrypt a secret. Each successful read decrements the view counter. The secret is destroyed when views reach zero or TTL expires.

Limits

Plan	Monthly secrets	TTL máx.	Max views
Free	10 secrets	24h	1
Pro	5.000 secrets	7 dias	100

Free plan secrets are capped at 24h TTL and 1 view regardless of the values sent. Pro limits apply the full requested values.