Delivery API reference

Read a project's published content, media and redirects, and send events into it, over HTTPS and JSON. This is the API your website, app or backend calls at runtime. ### Authentication Send a project API key in the `X-API-Key` header. Create keys in the dashboard under **Settings → API Keys**. A key carries `read` and/or `write` permission and can be limited to a single project: - `read` — content, media, redirects and storefront reads. - `write` — ingesting events and engagement data. A key is shown once, when it is created. For anything shipped to a browser, use a read-only key limited to one project. ### Responses Bodies are JSON. Collections come back as `{ "data": [...], "meta": { ... } }`; each operation below shows its exact shape. ### Caching Content responses carry `Cache-Control` and an `ETag`. Send the ETag back in `If-None-Match` to get `304 Not Modified` with no body. ### Errors Every error response has the same shape. Branch on `error.code`, never on `error.message`, whose wording can change. ```json { "error": { "code": "NOT_FOUND", "message": "Content entry not found: hello-world" } } ``` Validation failures use `VALIDATION_ERROR` and list the offending fields under `error.details`. ### Rate limits Requests are counted per API key (per client IP when no key is sent) in a fixed one-minute window. The default limit is 100 requests per minute. Beyond it the API answers `429` with a `Retry-After` header giving the seconds until the window resets.

Base URL: https://api.akorrah.com

Content

Read published entries of your content types.

  • GET /api/v1/content/{projectSlug}/_openapi — Get this project's OpenAPI document
  • GET /api/v1/content/{projectSlug}/_schema — List content type schemas
  • GET /api/v1/content/{projectSlug}/_schema/{typeSlug} — Get one content type schema
  • GET /api/v1/content/{projectSlug}/{typeSlug} — List entries
  • GET /api/v1/content/{projectSlug}/{typeSlug}/{entrySlug} — Get an entry by slug

SEO

Sitemaps, robots.txt, llms.txt and per-entry structured data.

  • GET /api/v1/content/{projectSlug}/_json-ld — Get the site's JSON-LD
  • GET /api/v1/content/{projectSlug}/llms.txt — Get llms.txt
  • GET /api/v1/content/{projectSlug}/robots.txt — Get robots.txt
  • GET /api/v1/content/{projectSlug}/sitemap.xml — Get sitemap.xml
  • GET /api/v1/content/{projectSlug}/{typeSlug}/{entrySlug}/hreflang — Get an entry's hreflang links
  • GET /api/v1/content/{projectSlug}/{typeSlug}/{entrySlug}/json-ld — Get an entry's JSON-LD
  • GET /api/v1/content/{projectSlug}/{typeSlug}/{entrySlug}/open-graph — Get an entry's Open Graph tags

Media

Resized images and responsive `srcset` descriptors.

  • GET /api/v1/media/{projectSlug}/{id}/render — Render a resized image
  • GET /api/v1/media/{projectSlug}/{id}/srcset — Get a responsive srcset

Redirects

Resolve or bulk-load a project's redirect rules.

  • GET /api/v1/redirects/{projectSlug}/all — List all active redirects
  • GET /api/v1/redirects/{projectSlug}/resolve — Resolve one path

Storefront

Products, cart quotes and checkout for digital commerce.

  • POST /api/v1/store/{projectSlug}/cart/quote — Quote a cart
  • POST /api/v1/store/{projectSlug}/checkout — Start a checkout
  • GET /api/v1/store/{projectSlug}/coupons/{code} — Look up a coupon
  • GET /api/v1/store/{projectSlug}/products — List products
  • GET /api/v1/store/{projectSlug}/products/{slug} — Get a product

Licensing

Activate and verify license keys from software you sell. No API key needed.

  • POST /api/v1/store/license/activate — Activate a license on a machine
  • GET /api/v1/store/license/verify — Verify a license key

Events

Send custom events from your own systems.

  • POST /api/v1/events/{projectSlug} — Send an event

Engagement

Identify people, record consent and preferences, and register devices.

  • POST /api/v1/engagement/{projectSlug}/consent — Record consent
  • POST /api/v1/engagement/{projectSlug}/deliveries/{deliveryId}/callback — Report a delivery status
  • POST /api/v1/engagement/{projectSlug}/devices — Register a device
  • POST /api/v1/engagement/{projectSlug}/identify — Identify a person
  • GET /api/v1/engagement/{projectSlug}/in-app — List in-app messages
  • POST /api/v1/engagement/{projectSlug}/preferences — Set a delivery preference
  • POST /api/v1/engagement/{projectSlug}/whatsapp-otp/send — Send a WhatsApp login code
  • POST /api/v1/engagement/{projectSlug}/whatsapp-otp/verify — Verify a WhatsApp login code