> 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/shareproject.md).

# Share a project by link

Share a project by link with the FLORA API: POST /projects/{projectId}/share.

Shares the project the way the canvas Share tab does and returns the link: opens link sharing at the requested access (`view` or `edit`) and returns the reusable link for that access, creating it on first use. Escalate-only — sharing for `view` never downgrades a project already shared for `edit`; use PATCH /projects/{project\_id}/sharing to lower or restrict access. `edit` requires the workspace plan to include editable sharing and returns `paid_plan_required` otherwise; a caller who may not manage the project's sharing gets `forbidden`. Anyone holding the returned link gets its role. 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/projects/{projectId}/share
```

* **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.projects.sharing.share()`.
* **Idempotency:** optional `Idempotency-Key` header. See [Idempotency](https://docs.flora.ai/api/platform/idempotency.md).
* **Operation ID:** `shareProject`.

## Example

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

```bash
curl -X POST 'https://app.flora.ai/api/v1/projects/prj_abc123/share' \
  -H "Authorization: Bearer $FLORA_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "access": "view"
}'
```

{% endtab %}

{% tab title="TypeScript SDK" %}

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

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

const sharing = await client.projects.sharing.share({
  projectId: 'prj_abc123',
  access: 'view',
});
console.log(sharing);
```

{% endtab %}
{% endtabs %}

## Path parameters

| Name        | Type   | Required | Description                                                      |
| ----------- | ------ | -------- | ---------------------------------------------------------------- |
| `projectId` | string | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`. |

## Request body

Required.

| Field            | Type    | Required | Description                                                                                                                                                                                                                                            |
| ---------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `access`         | string  | Yes      | What the link should grant. `edit` needs the workspace plan to include editable sharing (otherwise `paid_plan_required`). Never downgrades: a project already shared for editing stays that way and its view link is returned. One of: `view`, `edit`. |
| `allow_comments` | boolean | No       | Whether visitors arriving through the link may leave comments. Omit to keep the current setting (on by default).                                                                                                                                       |
| `passphrase`     | string  | No       | Require this passphrase before the link resolves. Stored hashed; omit to keep the current setting. Whitespace-only values are rejected. 1 to 200 characters.                                                                                           |

## Responses

### 200: Project shared; link returned.

| Field          | Type         | Required | Description                                                                                                                                                                     |
| -------------- | ------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `project_id`   | string       | Yes      | Project identifier. Pattern: `^prj_\S+$`. Example: `prj_abc123`.                                                                                                                |
| `workspace_id` | string       | Yes      | Workspace identifier. Pattern: `^ws_\S+$`. Example: `ws_abc123`.                                                                                                                |
| `url`          | string (uri) | Yes      | Link into the project. Anyone who has it gets the link's role, so treat it as a secret.                                                                                         |
| `role`         | string       | Yes      | What the link grants: `guest` can view (and comment when allowed), `editor` can edit. One of: `guest`, `editor`.                                                                |
| `sharing_mode` | string       | Yes      | Link sharing mode: `restricted` (no links; members only), `view` (anyone with the link can view), `edit` (anyone with the link can edit). One of: `restricted`, `view`, `edit`. |
| `created`      | boolean      | Yes      | True when this call created the link; false when an existing link was returned                                                                                                  |
| `canvas_url`   | string (uri) | Yes      | Project canvas URL                                                                                                                                                              |

## 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/shareproject.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.
