Skip to main content
POST
/
api
/
v1
/
share
Create share link
curl --request POST \
  --url https://handauncle-backend-prod-205012263523.asia-south1.run.app/api/v1/share \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversationId": "<string>",
  "shareType": "full",
  "messageIds": [
    "<string>"
  ],
  "visibility": "public",
  "allowContinuation": false,
  "expires_in_days": 183,
  "customTitle": "<string>",
  "customDescription": "<string>"
}
'
{
  "success": true,
  "data": {
    "shareId": "<string>",
    "shareUrl": "<string>",
    "conversation": {
      "id": "<string>",
      "shareId": "<string>",
      "userId": "<string>",
      "conversationId": "<string>",
      "shareType": "full",
      "visibility": "public",
      "allowContinuation": true,
      "viewCount": 123,
      "continuationCount": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "status": "active",
      "messageIds": [
        "<string>"
      ],
      "customTitle": "<string>",
      "customDescription": "<string>",
      "lastViewedAt": "2023-11-07T05:31:56Z",
      "expiresAt": "2023-11-07T05:31:56Z",
      "revokedAt": "2023-11-07T05:31:56Z"
    }
  },
  "meta": {
    "timestamp": "2023-11-07T05:31:56Z",
    "requestId": "<string>"
  }
}
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

FieldTypeRequiredDescription
conversationIdstring✅MongoDB ObjectId of the conversation to share
shareTypestring⛔full (default) or partial
messageIdsstring[]⛔Required when shareType is partial
visibilitystring⛔public (default), private, or organization
allowContinuationboolean⛔Allow viewers to fork the conversation (default: false)
expiresInDaysnumber⛔Days until expiration (1-365)
customTitlestring⛔Custom title for the share (max 200 chars)
customDescriptionstring⛔Description for the share (max 500 chars)

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