Skip to main content
POST
Create share link
Creates a new public (or org/private) link for an existing conversation. Provide the conversationId, choose shareType (full versus partial with explicit messageIds), and optionally set visibility, expiration, continuation, and custom copy blocks.

Request Body

Authorizations

Authorization
string
header
required

Auth0 access token for registered users.

Body

application/json
conversationId
string
required
shareType
enum<string>
default:full
Available options:
full,
partial
messageIds
string[]
visibility
enum<string>
default:public
Available options:
public,
private,
organization
allowContinuation
boolean
default:false
expires_in_days
integer
Required range: 1 <= x <= 365
customTitle
string
Maximum string length: 200
customDescription
string
Maximum string length: 500

Response

Share created.

success
enum<boolean>
required
Available options:
true
data
object
required
meta
object
required