Skip to main content
POST
Create or refresh chat share link

Authorizations

x-teamai-api-key
string
header
required

Secret API key created in Workspace Settings → API Keys (workspace keys) or Organization Admin → API Keys (organization keys).

Path Parameters

chatId
string
required

Chat ID. Must be a chat in the API key's workspace that the key's user can access. Organization API keys are bound to the organization's own workspace, so chats in its member workspaces return 404; use a workspace key.

Body

application/json
scope
enum<string>
required

Who can open the link. workspace: signed-in members of the chat's workspace. organization: signed-in members of any workspace in its organization. public: anyone with the link.

Available options:
workspace,
organization,
public

Response

The created or refreshed share link.

data
object