Cloud API Explained

The Cloud API is a production-ready backend service that provides all the server-side functionality for your AI applications. Production Servers:

• api.devkit4ai.com — Primary production server
• api.vibecoding.ad — Alternative production server

Both servers provide identical functionality. Your Starter Kit connects to one of these servers based on your environment configuration.

​

What It Provides

​

Authentication Services

• User registration: Create new user accounts with email and password
• Login/logout: Secure authentication with JWT tokens
• Token refresh: Automatic token renewal for continuous sessions
• Email verification: Verify user email addresses
• Password reset: Secure password recovery flow
• Session management: Handle user sessions across devices

​

Project Management

• Project CRUD: Create, read, update, and delete projects
• API key generation: Create project-scoped authentication keys
• Key management: List, revoke, and track API key usage
• Project isolation: Multi-tenant architecture ensures data separation

​

AI Generation

• Image generation: Create AI images using Replicate models
• Status tracking: Monitor generation progress and completion
• History management: Access past generations for authenticated users
• Public sharing: Toggle image visibility for sharing
• Anonymous generation: Support for unauthenticated generation flows

​

Health & Monitoring

• Health checks: Verify API availability and status
• Database status: Check backend database connectivity
• Storage status: Verify file storage availability
• Detailed diagnostics: Get comprehensive system information

​

How Authentication Works

​

JWT Token Flow

​

Required Headers

All API requests from your Starter Kit include these authentication headers:

• X-User-Role: Identifies the user type (end_user for Starter Kit users)
• X-Developer-Key: Your developer credential from Cloud Admin
• X-Project-ID: Your project’s unique identifier (UUID format)
• X-API-Key: Your project’s API key
• Authorization: JWT token for authenticated user requests

​

Role-Based Access

Different user types have different access levels to API endpoints:

​

API Endpoints

The Cloud API is organized into logical groups:

​

Health Check Endpoints

• GET /health - Quick health status
• GET /api/v1/health - Comprehensive health check
• GET /api/v1/health/database - Database connectivity
• GET /api/v1/health/storage - File storage status
• GET /api/v1/health/redis - Cache status (if configured)

​

Authentication Endpoints

• POST /api/v1/auth/register - Create new user
• POST /api/v1/auth/login - Authenticate user
• GET /api/v1/auth/me - Get current user info
• POST /api/v1/auth/refresh - Refresh access token
• POST /api/v1/auth/verify-email - Verify email address
• POST /api/v1/auth/request-verification - Request verification email

​

Project Endpoints

• GET /api/v1/projects - List user’s projects
• POST /api/v1/projects - Create new project
• GET /api/v1/projects/{id} - Get project details
• DELETE /api/v1/projects/{id} - Delete project
• POST /api/v1/projects/{id}/api-keys - Generate API key
• GET /api/v1/projects/{id}/api-keys - List project keys
• DELETE /api/v1/projects/{id}/api-keys/{key_id} - Revoke key

​

Generation Endpoints

• POST /api/v1/generation/generate-v2 - Create AI generation
• GET /api/v1/generation/{id}/status - Check generation status
• GET /api/v1/generation - List user’s generations
• PATCH /api/v1/generation/{id}/public - Toggle visibility
• DELETE /api/v1/generation/{id} - Delete generation
• GET /api/v1/generation/public - List public generations

​

Integration with Starter Kit

The Starter Kit is pre-configured to work with the Cloud API:

1. Environment variables set the API URL and credentials
2. Deployment mode validates configuration on startup
3. Server actions in app/actions.ts call API endpoints
4. Authentication context manages user state from API responses
5. Headers automatically included in all requests

​

Rate Limits & Quotas

​

API Documentation

For detailed endpoint documentation, request/response examples, and parameter descriptions, see the Cloud API Reference section.

​

Next Steps