FLflorafauna-ai
Projects

Share a project by link

Changed on

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.

post/projects/{projectId}/share

Request

  • Base URL
    https://app.flora.ai/api/v1
  • URL
    https://app.flora.ai/api/v1/projects/{projectId}/share
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Project identifier

Example:prj_abc123

Request body

access'view' | 'edit' required

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.

allow_commentsboolean

Whether visitors arriving through the link may leave comments. Omit to keep the current setting (on by default).

passphrasestring

Require this passphrase before the link resolves. Stored hashed; omit to keep the current setting. Whitespace-only values are rejected.

Response

Project shared; link returned.

project_idstring required

Project identifier

workspace_idstring required

Workspace identifier

urlstring uri required

Link into the project. Anyone who has it gets the link's role, so treat it as a secret.

role'guest' | 'editor' required

What the link grants: guest can view (and comment when allowed), editor can edit

sharing_mode'restricted' | 'view' | 'edit' required

Link sharing mode: restricted (no links; members only), view (anyone with the link can view), edit (anyone with the link can edit)

createdboolean required

True when this call created the link; false when an existing link was returned

canvas_urlstring uri required

Project canvas URL

Example response

{
  "project_id": "prj_abc123",
  "workspace_id": "ws_abc123"
}

Changes

  • a8351619f225Revision changes
    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

    • warning

      added the new not_configured enum value to the / response property for the response status

  • e54130373b10Revision changes
    • info

      endpoint added