Projects

Create Project Invitation

Invites one user to the project by email. The invitation email is sent automatically. The invited user becomes a project member only after accepting — until then they cannot be added to a restricted chat’s audience.

Each project holds at most one invitation per role. When one already exists for the requested role, the email is added to it and that invitation is returned; inviting an email that is already on it succeeds with the current state. 409 with code publicapi.projects.invitations.create.role.exists occurs only when a concurrent request creates the role’s invitation mid-flight — retrying adds the email to it.

POST

projects

{id}

invitations

Error

A valid request URL is required to generate request examples

{
  "invitation_id": "boundary_d8aad64dib2c7m3ae7j0",
  "email": "alice@example.com",
  "role": "collaborator",
  "url": "https://auth.storytell.ai/roles/collaborator/inv_tok_3xa…",
  "created_at": "2026-05-01T12:00:00Z"
}

{
  "code": "publicapi.tenancy.project.missing",
  "humane": "X-Project-Id header is required.",
  "statusCode": 400
}

{
  "code": "publicapi.auth.invalid",
  "humane": "The provided API key is invalid or has been revoked.",
  "statusCode": 401
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

{
  "code": "publicapi.chats.members.add.not_restricted",
  "humane": "Set chat visibility to restricted before managing members.",
  "statusCode": 409
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

Authorizations

X-API-Key

string

header

required

Personal Access Token, sent verbatim as pat_<32 chars>. PATs are minted from the Chief settings UI.

Path Parameters

string

required

Project identifier in the path. Project routes carry no tenancy header; ids outside the caller's reach respond with HTTP 404.

Pattern: ^project_[a-z0-9]{20}$

Body

application/json

string<email>

required

role

enum<string>

required

Role granted on acceptance. Validated before anything is persisted; unknown values respond with code publicapi.projects.invitations.create.role.invalid.

Available options:

collaborator,

reader,

owner

Response

Invitation created, or the email was added to the role's existing invitation. The invitation email is sent to newly added addresses.

invitation_id

string

required

Pattern: ^boundary_[a-z0-9]{20}$

string<email>

required

role

enum<string>

required

Short public role name, echoing the request.

Available options:

collaborator,

reader,

owner

url

string<uri>

required

Shareable accept link — the same one sent in the invitation email.

created_at

string<date-time>

required

Revoke Project InvitationRevokes a pending invitation. Invitations outside the project, or projects outside the caller's reach, respond `404`.

⌘I

Error

A valid request URL is required to generate request examples

{
  "invitation_id": "boundary_d8aad64dib2c7m3ae7j0",
  "email": "alice@example.com",
  "role": "collaborator",
  "url": "https://auth.storytell.ai/roles/collaborator/inv_tok_3xa…",
  "created_at": "2026-05-01T12:00:00Z"
}

{
  "code": "publicapi.tenancy.project.missing",
  "humane": "X-Project-Id header is required.",
  "statusCode": 400
}

{
  "code": "publicapi.auth.invalid",
  "humane": "The provided API key is invalid or has been revoked.",
  "statusCode": 401
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

{
  "code": "publicapi.chats.members.add.not_restricted",
  "humane": "Set chat visibility to restricted before managing members.",
  "statusCode": 409
}

{
  "code": "publicapi.auth.invalid",
  "statusCode": 401,
  "humane": "The provided API key is invalid or has been revoked."
}

Introduction

Chats

Assets

Labels

Actions

Sessions

Skills

Memories

Projects

Create Project Invitation

Authorizations

Path Parameters

Body

Response