---
title: "createProject"
description: "Create a project"
canonical: "https://pgbeam.com/docs/ts-sdk/projects/createProject"
last-updated: "2026-10-30T13:32:17.000Z"
---

# createProject

> Create a project

URL: https://pgbeam.com/docs/ts-sdk/projects/createProject

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Creates a new project within the specified organization.

## Usage

```typescript
const result = await api.projects.createProject({
    body: {
      name: "my-app",
      org_id: "org_abc123",
      database: { ... },
    },
  });
```

## Parameters

| Parameter        | Type                        | Required | Description                                                                                                                               |
| ---------------- | --------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| body.name        | `string`                    | Yes      | Human-readable project name.                                                                                                              |
| body.org_id      | `string`                    | Yes      | Better Auth organization ID.                                                                                                              |
| body.description | `string`                    | No       | Optional project description.                                                                                                             |
| body.tags        | `string[]`                  | No       | User-defined labels to attach to the project.                                                                                             |
| body.cloud       | `"aws" \| "azure" \| "gcp"` | No       | Cloud provider for the project.                                                                                                           |
| body.self_hosted | `boolean`                   | No       | Mark this project as running on a self-hosted (BYOC) data plane in the customer's own VPC/cluster. Requires the Scale or enterprise plan. |
| body.database    | `CreateDatabaseRequest`     | Yes      | Request body for registering an upstream database.                                                                                        |

## Response

`Promise<CreateProjectResponse>`: project created.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: "pbu_...",
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.projects.createProject({
  body: {
      name: "my-app",
      org_id: "org_abc123",
      database: { ... },
    },
});
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.                                 |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                                                 |
| 429    | Rate limited. `code` is `RATE_LIMITED`.                                                                                                                                                                                                                                                                                               |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                                                        |