API Reference

All API endpoints are served from your ShipKit deployment URL.

---

MCP Endpoint

POST /api/mcp

The primary interface for AI coding tools. Implements JSON-RPC 2.0 over HTTP.

Authentication: Authorization: Bearer skyourkey header (preferred) or ?apikey=skyour_key query parameter (deprecated). Rate limit: 60 requests/minute per IP. Request:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "shipkit_usage",
    "arguments": {}
  }
}

Response (success):

{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "content": [
      {
        "type": "text",
        "text": "{\"plan\":\"pro\",\"capturesused\":42,\"captureslimit\":500}"
      }
    ]
  }
}

Response (error):

{
  "jsonrpc": "2.0",
  "id": 1,
  "error": {
    "code": -32000,
    "message": "Invalid API key"
  }
}

JSON-RPC error codes: Supported methods:

See the MCP Integration Guide (/guide/mcp-guide) for the full list of 30 tools.

---

Docs API

Public API for reading hosted documentation. Use this to serve ShipKit-hosted docs on your own website.

GET /api/docs/[siteId]

Returns site navigation and page list for a hosted documentation site.

Authentication: Authorization: Bearer skyourkey or ?apikey=skyour_key Response:

{
  "site_title": "MyProduct Docs",
  "navigation": [
    { "label": "Getting Started", "path": "getting-started" },
    { "label": "API Reference", "path": "api" }
  ],
  "pages": [
    { "path": "getting-started", "title": "Getting Started" },
    { "path": "api", "title": "API Reference" }
  ],
  "updated_at": "2026-03-20T12:00:00Z"
}

---

GET /api/docs/[siteId]/[...path]

Returns the content of a specific documentation page.

Authentication: Authorization: Bearer skyourkey or ?apikey=skyour_key Response:

{
  "title": "Getting Started",
  "content": "# Getting Started\n\nWelcome to MyProduct...",
  "updated_at": "2026-03-20T12:00:00Z"
}

Cache: Cache-Control: public, max-age=60 (1-minute cache). Errors:

---

Webhook Endpoint

POST /api/webhooks/test

Send a test webhook to verify your endpoint configuration.

Authentication: Supabase session (browser cookie). Request:

{
  "webhook_url": "https://your-server.com/webhook",
  "webhook_secret": "your-secret-string"
}

Response (success):

{
  "success": true,
  "status": 200,
  "message": "Test webhook delivered successfully."
}

---

Health Endpoint

GET /api/health

Public health check. No authentication required.

Response:

{
  "status": "ok",
  "timestamp": "2026-03-22T10:00:00.000Z",
  "version": "5.7.0",
  "env": {
    "ready": true,
    "configured": 8,
    "missing": 0,
    "ai_enabled": true,
    "billing_enabled": true
  }
}

---

Internal REST Endpoints

These endpoints are used by the ShipKit web dashboard. They require Supabase session authentication (cookie-based).

Projects

Captures & Diffs

Documentation

Hosted Sites

Launch & Promote

Account & Billing