DocsREST API

HTTP Integration Surfaces

AutoKap is CLI-first for project, preset, capture, usage, and auth account management. This page documents the HTTP surfaces that are intentionally public for embedding, serving assets, and integrating interactive demos.

CLI-first management

Use autokap project, autokap preset,autokap capture, autokap usage,autokap endpoints, and autokap auth for the normal management workflow. The REST backend remains in place to support the CLI, but raw management routes are no longer the documented default path.

Shell

npx autokap@latest init --cli-key <your-cli-key>
autokap project list
autokap preset info <preset-id>
autokap run <preset-id>
autokap endpoints export --preset <preset-id>
autokap capture list --preset <preset-id>
autokap usage

Public asset URLs

GET /api/v1/assets/:id

Stable public asset URL for the latest published screenshot, clip, or composition image.

HTML

<img src="https://autokap.app/api/v1/assets/ENDPOINT_ID?w=1024&format=webp" alt="Latest capture" />

Loader script

GET /api/v1/loader.js

Client-side helper that rewrites data-ak-id image tags to public asset URLs.

HTML

<script src="https://autokap.app/api/v1/loader.js" data-ak-base="https://autokap.app/api/v1/assets" defer></script>
<img data-ak-id="ENDPOINT_ID" data-ak-lang="en" alt="Screenshot" />

Interactive demo runtime

GET /demo/:presetId

GET /api/v1/demos/:presetId/states/:stateName

POST /api/v1/demos/:presetId/events

Published interactive demos are served over HTTP and can be embedded in docs or marketing pages.

HTML

<iframe src="https://autokap.app/demo/PRESET_ID?embed=1" title="Product demo" loading="lazy" />

Endpoint export

GET /api/v1/endpoints/export

Export endpoint metadata when you need a static JSON or CSV artifact in CI or a build step.

Shell

# Prefer the CLI
autokap endpoints export --preset <preset-id>
autokap endpoints export --preset <preset-id> --format csv

Proxy and webhook integration

User-side proxy routes, demo rewrites, and the webhook handler stay HTTP by design because they run on your own domain.

Shell

autokap proxy register --project <project-id> --proxy-url https://your-domain.com/api/autokap/assets --webhook-url https://your-domain.com/api/autokap/webhook
autokap proxy verify --project <project-id>