SkyKoiSKYKOIDocs
Docs/API Reference/API Overview

API Overview

SkyKoi platform API — currently internal, public API coming soon.

💡The SkyKoi API is currently **internal** — used by the dashboard to manage provisioning, billing, and koi configuration. A public API for programmatic access is **coming soon**.

The SkyKoi platform uses a Next.js API layer (hosted on Vercel) for all dashboard operations. Key internal endpoints are documented below for reference.

Authentication

All API requests are authenticated via Clerk session tokens (for dashboard use) or API keys (coming soon for programmatic access).

Internal Endpoints

These endpoints power the SkyKoi dashboard:

Kois

GET/api/koi

List all kois in your organization

POST/api/koi

Create a new koi (triggers EC2 provisioning)

GET/api/koi/:id

Get koi details including instance status

PUT/api/koi/:id

Update koi configuration

DELETE/api/koi/:id

Stop the koi and terminate the EC2 instance

Infrastructure

POST/api/infra/deployments

Launch a dedicated EC2 instance for a koi

GET/api/infra/instances

List running EC2 instances with health status

GET/api/infra/models

List available models (currently Claude Opus 4.6 via AWS Bedrock)

Billing

POST/api/billing/checkout

Create a Stripe Checkout session

GET/api/billing/subscription

Get current subscription status

GET/api/billing/usage

Get current-period usage metrics

Team

GET/api/team

List all team members and pending invites

POST/api/team

Send an invitation (requires ADMIN role)

Public API (Coming Soon)

A public REST API with API key authentication is planned. It will enable:

  • •Programmatic koi provisioning and management
  • •Sending messages to kois via API
  • •Retrieving usage metrics and billing data
  • •Webhook configuration for koi events
NextSecurity Model →