DocumentationREST API

HTTP Integration Surfaces

AutoKap manages projects, presets, captures, usage, and auth via the MCP server and the bundled CLI binary. This page documents the HTTP surfaces that are intentionally public for embedding and serving assets.

Project management

Use the MCP tools (autokap_list_projects, autokap_get_preset_info, autokap_start_capture, autokap_get_usage, autokap_export_endpoints, autokap_authenticate) from your IDE for the normal management workflow. The REST backend powers both the MCP server and the bundled CLI binary; raw management routes are intentionally not documented as a public path.

Text

// From the IDE chat, once @autokap/mcp is installed:
autokap_authenticate({ apiKey: "ak_cli_..." })
autokap_list_projects()
autokap_get_preset_info({ presetId: "<preset-id>" })
autokap_start_capture({ presetId: "<preset-id>" })
autokap_export_endpoints({ presetId: "<preset-id>" })
autokap_list_captures({ presetId: "<preset-id>" })
autokap_get_usage()

Public asset URLs

GET /api/v1/assets/:id

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

HTML

<!-- Proxy mode — emit through your registered proxy domain: -->
<img src="https://yourapp.com/api/autokap/assets/ENDPOINT_ID?w=1024&format=webp" alt="Latest capture" />

<!-- Download mode — emit through your bundled CDN path: -->
<img src="/autokap/ENDPOINT_ID-en-light-w1024.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

<!-- The loader is used in PROXY mode only — `data-ak-base` points at your proxy. -->
<script src="https://autokap.app/api/v1/loader.js" data-ak-base="https://yourapp.com/api/autokap/assets" defer></script>
<img data-ak-id="ENDPOINT_ID" data-ak-lang="en" alt="Screenshot" />

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.

Text

// Prefer the MCP tool from your IDE
autokap_export_endpoints({ presetId: "<preset-id>" })
autokap_export_endpoints({ presetId: "<preset-id>", format: "csv" })

Proxy and webhook integration

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

Text

// MCP tools (from the IDE chat)
autokap_register_proxy({
  projectId: "<project-id>",
  proxyUrl: "https://your-domain.com/api/autokap/assets",
  webhookUrl: "https://your-domain.com/api/autokap/webhook"
})
autokap_verify_proxy({ projectId: "<project-id>" })