Skip to content

API Reference

Public API reference for Zayenha Bio — bio pages, vCard, analytics beacons, health probes.

Version: v3 Base: https://bioz.cc Response: JSON / HTML

Authentication

All public endpoints are unauthenticated. Private endpoints rely on a Zayenha Hub session (cookies set after sign-in at auth.zayenha.com). Webhooks are HMAC-SHA256 signed.

Endpoints

GET /:slug public

Public bio page (HTML). Served from Cloudflare edge cache for speed.

GET https://bioz.cc/your-slug
GET /vcard/:slug.vcf public

RFC 6350 vCard for the page — imports straight into the OS contacts app.

GET https://bioz.cc/vcard/your-slug.vcf
POST /api/analytics/view public

Anonymous beacon recording a view or link click. IP-rate-limited.

POST /api/analytics/view
{"page_id":"…","link_id":"…"}
POST /api/log/error public

Client-side JS error reporting. Limited to 30 req/min/IP.

POST /api/log/error
{"message":"…","stack":"…","severity":"error"}
GET /health public

Shallow health check — 200 if the Worker is responsive.

GET /health → {"ok":true,"app":"bio","version":"3.0.0"}
GET /health/deep public

Deep probe that pings D1, KV, R2, and the Hub API. Returns 503 on any failure.

GET /health/deep
GET /sitemap.xml public

Site index for search engines.

GET /robots.txt public

Crawl policy.

GET /manifest.json public

PWA manifest — enables install-to-home on mobile.

GET /llms.txt public

Standards.dev LLM-friendly description of the service.

GET /api/me/wallet session

Hub-wallet points for the logged-in user. Requires a Hub session.

GET /api/me/notifications session

User notifications.

Rate Limits

  • Public endpoints: 60 req/min per IP.
  • /api/auth/*: 10 req/min per IP.
  • Tip jar (/api/tip): 20/min per IP.
  • Downloads (/api/download): 30/min per IP.
  • Newsletter signup: 10/min per IP.
  • AI endpoints: per-plan quota.

Error Envelope

Every error follows a single machine-parseable shape:

{
  "ok": false,
  "error": "Human-readable Arabic",
  "message_en": "Human-readable English",
  "code": "CSRF_REQUIRED",
  "details": { ... }
}

Need help integrating?

Contact us