Skip to main content
POST
Create a retained widget session

Authorizations

Authorization
string
header
required

MCPJam API key (sk_…). Create one at Settings → API keys. Guest sessions cannot use the API, and API keys cannot manage other API keys.

Path Parameters

projectId
string
required

ID of the hosted project that contains the server.

serverId
string
required

ID of the server inside the project.

Body

application/json
toolName
string
required
Minimum string length: 1
parameters
object
injectOpenAiCompat
boolean
viewport
object
clientCapabilities
object

Response

The session operation result.

A render verdict. Only a rendered widget has a session ID and lifetime metadata; an unsuccessful render does not create a session.

status
string
required
elapsedMs
number
required
sessionId
string
serverId
string
mountedWidgetId
string
viewport
object
createdAt
number
expiresAt
number
idleTimeoutMs
number
resourceUri
string
bridgeInitialized
boolean
screenshotBase64
string
consoleErrors
string[]
blockedRequests
string[]
hint
string