API Reference

Public API Reference

The public API exposes tool, release, and asset metadata for integration purposes. All responses are JSON, and only public releases are returned.

Base URL

/api/public

List available tools

GET /api/public/tools

Returns tools with their latest public release (if available).

{
  "items": [
    {
      "id": "ckv0...",
      "slug": "deploy-cli",
      "name": "deploy-cli",
      "summary": "Zero-config deployments to the edge...",
      "category": { "name": "Deployment", "slug": "deployment" },
      "latestVersion": "v2.4.0"
    }
  ],
  "total": 1
}

List public versions for a tool

GET /api/public/tools/{slug}/versions

{
  "tool": { "slug": "deploy-cli", "name": "deploy-cli" },
  "versions": [
    {
      "version": "v2.4.0",
      "summary": "Multi-cluster deployments...",
      "publishedAt": "2023-10-24T12:00:00.000Z",
      "isLatest": true
    }
  ]
}

Fetch release assets for a version

GET /api/public/tools/{slug}/releases/{version}/assets

{
  "tool": { "slug": "deploy-cli", "name": "deploy-cli" },
  "release": {
    "version": "v2.4.0",
    "summary": "Multi-cluster deployments...",
    "publishedAt": "2023-10-24T12:00:00.000Z"
  },
  "assets": [
    {
      "label": "macOS Apple Silicon",
      "kind": "BINARY",
      "os": "macOS",
      "arch": "arm64",
      "format": ".tar.gz",
      "size": "46 MB",
      "checksum": null,
      "containerImage": null,
      "downloadUrl": "https://.../deploy-cli_darwin_arm64.tar.gz"
    }
  ]
}

Check if an update is available

GET /api/public/tools/{slug}/compare?version=v2.3.0

{
  "tool": { "slug": "deploy-cli", "name": "deploy-cli" },
  "compareVersion": "v2.3.0",
  "latestVersion": "v2.4.0",
  "hasUpdate": true
}