Skip to main content
POST
Create a share snapshot of a conversation or single message

Authorizations

Authorization
string
header
required

User-bound credential carrying an identity: either a session JWT or a user access token (at:*) generated from the user settings UI. Send as Authorization: Bearer <token>. Org API keys (iak_*) are not accepted here - they carry no user identity. Use the x-prismeai-api-key header instead (see OrgApiKeyAuth).

Path Parameters

agentId
string
required
Maximum string length: 64
contextId
string
required
Maximum string length: 64

Body

application/json
message_id
string

Optional - when set, share is scoped to this single message (type: "message" instead of "conversation").

Maximum string length: 128

Response

Share created.

id
string
type
enum<string>
Available options:
conversation,
message
url
string

UI URL on the caller's origin (/share/{share_id}).

apiUrl
string

Public API URL pointing at /v1/shared/{shareId}.

created_at
string<date-time>