Project Tools

List all projects owned by or shared with the authenticated user.

Parameters

Returns

Array of project objects with id, name, createdAt, and thumbnail.

Example

// Request
{
  "skip": 0,
  "limit": 10
}

// Response
{
  "projects": [
    {
      "id": "abc123",
      "name": "My App",
      "createdAt": "2024-01-15T10:30:00Z",
      "thumbnail": "https://..."
    }
  ],
  "total": 25
}

Get available starter templates for creating new projects.

No parameters required.

Returns

Array of template objects with name, description, and S3 key.

Example

// Response
{
  "templates": [
    {
      "name": "Next.js Starter",
      "description": "A minimal Next.js 14 app with TypeScript and Tailwind CSS",
      "s3Key": "templates/nextjs-starter.zip",
      "thumbnail": "https://..."
    },
    {
      "name": "E-commerce Template",
      "description": "Full-featured store with cart, checkout, and Stripe integration",
      "s3Key": "templates/ecommerce.zip",
      "thumbnail": "https://..."
    }
  ]
}

Create a new app from a starter template.

Parameters

Returns

The newly created project object.

Example

// Request
{
  "templateS3Key": "templates/nextjs-starter.zip",
  "name": "My New App"
}

// Response
{
  "id": "xyz789",
  "name": "My New App",
  "createdAt": "2024-01-20T15:45:00Z",
  "status": "ready"
}

Get detailed information about a specific project.

Parameters

Returns

Detailed project object including deployment status, collaborators, and settings.

Example

// Request
{
  "projectId": "abc123"
}

// Response
{
  "id": "abc123",
  "name": "My App",
  "createdAt": "2024-01-15T10:30:00Z",
  "owner": {
    "id": "user123",
    "email": "user@example.com"
  },
  "deployments": {
    "frontend": {
      "url": "https://myapp.appsai.com",
      "lastDeployed": "2024-01-19T08:00:00Z"
    },
    "backend": {
      "url": "https://api.myapp.appsai.com",
      "lastDeployed": "2024-01-18T12:00:00Z"
    }
  },
  "collaborators": []
}

Delete a project. Only the project owner can delete it.

Parameters

Returns

Confirmation of deletion.

Example

// Request
{
  "projectId": "abc123"
}

// Response
{
  "success": true,
  "message": "Project deleted successfully"
}