Get a session transcript

GET

projects

{projectId}

user-testing

scenarios

{scenarioId}

sessions

{sessionId}

Get a session transcript

curl --request GET \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "scenarioId": "<string>",
  "chatSessionId": "<string>",
  "modelId": "<string>",
  "startedAt": 123,
  "lastActivityAt": 123,
  "messageCount": 123,
  "messages": [
    {
      "role": "<string>",
      "text": "<string>",
      "toolName": "<string>",
      "createdAt": 123
    }
  ],
  "transcriptUnavailable": true,
  "nextCursor": "<string>"
}

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.

scenarioId

string

required

Scenario ID, as returned by publishing an environment or by the project's scenario reads.

sessionId

string

required

Chat session ID, as returned by the scenario's session list.

Body

application/json

Optional pagination cursor.

cursor

string

Opaque pagination cursor from a previous response's nextCursor. Don't parse it.

Response

The session and its messages.

A session's transcript, paged. The stored blob URL is NEVER returned: it is a direct handle with no further authorization, so handing it out would turn one authorized read into an unbounded, unrevocable one.

string

required

scenarioId

string

required

chatSessionId

string | null

required

modelId

string | null

required

startedAt

number | null

required

Epoch milliseconds.

lastActivityAt

number | null

required

Epoch milliseconds.

messageCount

integer | null

required

null — never 0 — when the transcript could not be read. Zero would be a claim the visitor said nothing, the opposite of what an unreadable blob means, and a caller checking only this field would act on it.

messages

object[]

required

Show child attributes

transcriptUnavailable

boolean

True when the stored conversation could not be read. Distinct from an empty messages, which means the visitor genuinely said nothing.

nextCursor

string

⌘I

Get a session transcript

curl --request GET \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/user-testing/scenarios/{scenarioId}/sessions/{sessionId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "scenarioId": "<string>",
  "chatSessionId": "<string>",
  "modelId": "<string>",
  "startedAt": 123,
  "lastActivityAt": 123,
  "messageCount": 123,
  "messages": [
    {
      "role": "<string>",
      "text": "<string>",
      "toolName": "<string>",
      "createdAt": 123
    }
  ],
  "transcriptUnavailable": true,
  "nextCursor": "<string>"
}

API Guides

Endpoints

Authorizations

Path Parameters

Body

Response