StatikAPI Documentation

Build APIs from your data — without backend complexity.

StatikAPI helps you combine external APIs with your own content, shape outputs, and publish reliable structured endpoints. These docs cover the open source foundation, with guidance for local CLI workflows, Cloudflare deployment, and hosted platform usage.

StatikAPI App

Use the hosted visual workflow when you want managed publishing, private APIs, and automation.

Open StatikAPI App

The open source CLI stays free and self-hostable. StatikAPI App adds hosted workflows, visual editing, automations, analytics, and private API access.

Last updated: May 2026

config export

Routes can optionally export:

js
export const config = { ... };

This is the per-route configuration surface.

The exact supported keys depend on the runtime path.


Regular CLI support

For the normal statikapi CLI path, the main supported route-level option is:

config.listIndex

Examples:

js
export const config = {
  listIndex: true,
};
js
export const config = {
  listIndex: {
    enabled: true,
    pick: ['id', 'title'],
  },
};

This is meaningful for:

  • dynamic routes
  • catch-all routes

It tells StatikAPI to emit a parent collection route in addition to the per-item routes.


Cloudflare adapter support

Cloudflare routes can also export:

js
export const config = {
  cloudflare: {
    public: false,
    webhook: true,
  },
};

config.cloudflare.public

  • omitted or true
    • route is public
    • emitted under /public/...
  • false
    • route is private
    • served by the Worker on the original route path

config.cloudflare.webhook

  • omitted
    • follows the project default
  • true
    • route can be rebuilt by webhook
  • false
    • route is skipped or rejected for webhook rebuilds, depending on the request

Combined example

js
export const config = {
  listIndex: {
    enabled: true,
    pick: ['id', 'title'],
  },
  cloudflare: {
    public: true,
    webhook: false,
  },
};

That means:

  • emit a collection route
  • treat this route as public on Cloudflare
  • do not allow webhook rebuilds for it

Validation notes

config must be an object when exported.

Invalid shapes cause a route/config load error instead of being silently ignored.

Get started

Ready to publish your first API?

Start locally with the CLI or use StatikAPI App when you want managed publishing and automation.

Start building for free View examples