> For the complete documentation index, see [llms.txt](https://docs.flora.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flora.ai/api/reference/projects/createworkspaceproject.md).

# Create a project in a workspace

Create a project in a workspace with the FLORA API: POST /workspaces/{workspaceId}/projects.

Creates a new Flora project in the workspace named in the path. Prefer this over `POST /projects` when a credential can reach more than one workspace: the destination is explicit rather than carried in the body. To file the project into a project folder, use the folder route below. Mutating public API requests support an optional Idempotency-Key header for client retries; duplicate keys within two hours return idempotency\_duplicate.

```http
POST https://app.flora.ai/api/v1/workspaces/{workspaceId}/projects
```

* **Auth:** API key as a bearer token, `Authorization: Bearer $FLORA_API_KEY`. See [Authentication](https://docs.flora.ai/api/platform/authentication.md).
* **TypeScript SDK:** `client.workspaces.projects.create()`.
* **Idempotency:** optional `Idempotency-Key` header. See [Idempotency](https://docs.flora.ai/api/platform/idempotency.md).
* **Operation ID:** `createWorkspaceProject`.

## Example

{% tabs %}
{% tab title="cURL" %}

```bash
curl -X POST 'https://app.flora.ai/api/v1/workspaces/ws_abc123/projects' \
  -H "Authorization: Bearer $FLORA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "Spring Campaign"
}'
```

{% endtab %}

{% tab title="TypeScript SDK" %}

```typescript
import { FloraClient } from '@flora-ai/flora';

const client = new FloraClient({ apiKey: process.env['FLORA_API_KEY'] });

const project = await client.workspaces.projects.create({
  workspaceId: 'ws_abc123',
  name: 'Spring Campaign',
});
console.log(project);
```

{% endtab %}
{% endtabs %}

## Path parameters

| Name          | Type   | Required | Description                                                      |
| ------------- | ------ | -------- | ---------------------------------------------------------------- |
| `workspaceId` | string | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`. |

## Request body

Required.

| Field  | Type   | Required | Description                                                     |
| ------ | ------ | -------- | --------------------------------------------------------------- |
| `name` | string | Yes      | Project name. At least 1 character. Example: `Spring Campaign`. |

## Responses

### 201: Project created.

| Field           | Type                 | Required | Description                                                                                                                                                                                                                             |
| --------------- | -------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id`    | string               | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`.                                                                                                                                                                        |
| `name`          | string               | Yes      | Project name. Example: `Spring Campaign`.                                                                                                                                                                                               |
| `thumbnail_url` | string (uri) or null | No       | HTTPS project thumbnail URL, or null when unavailable. Uses the manual cover, then the automatic thumbnail, then the legacy project picture. Non-HTTPS URLs are returned as null.                                                       |
| `is_private`    | boolean              | No       | True when only the creator sees the project, rather than the whole workspace. Absent when the API cannot tell.                                                                                                                          |
| `workspace_id`  | string               | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`.                                                                                                                                                                        |
| `origin`        | string or null       | Yes      | Project origin. Example: `api`.                                                                                                                                                                                                         |
| `last_modified` | number or null       | Yes      |                                                                                                                                                                                                                                         |
| `created_at`    | number               | Yes      |                                                                                                                                                                                                                                         |
| `copy_status`   | string               | Yes      | `copying` while a copy's canvas and media are still being written; it cannot be opened yet. `failed` when the copy did not finish; retry or delete it in the app. Every other project is `ready`. One of: `copying`, `ready`, `failed`. |

## Errors

Every error has the same body: `error.code`, `error.message`, and `error.fields` on validation errors. See [Errors](https://docs.flora.ai/api/platform/errors.md) for how to recover from each code.

| Status | Code                                         | Meaning                                                                             |
| ------ | -------------------------------------------- | ----------------------------------------------------------------------------------- |
| 400    | `invalid_json`, `input_validation_error`     | The body isn't valid JSON, or an input failed validation (`fields` lists each one). |
| 401    | `unauthorized`, `invalid_api_key`            | The API key is missing, invalid or revoked.                                         |
| 402    | `insufficient_credits`                       | The workspace balance is too low for this request.                                  |
| 403    | `forbidden`, `paid_plan_required`            | The key can't do this, or the workspace plan doesn't include it.                    |
| 404    | `not_found`                                  | The resource doesn't exist or isn't visible to this key.                            |
| 409    | `idempotency_duplicate`, `revision_conflict` | Duplicate `Idempotency-Key` or a stale `base_revision`.                             |
| 429    | `rate_limited`                               | Too many requests. Back off and retry.                                              |
| 500    | `unknown_error`, `internal_error`            | Something failed on FLORA's side. Retry with backoff.                               |
| 503    | `temporarily_unavailable`                    | Authorization is temporarily unavailable. Retry later.                              |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flora.ai/api/reference/projects/createworkspaceproject.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
