Execution
Run a retained widget step
Available only on the local Inspector that created the session; hosted deployments return 404. Requires a verified user or API key. A session is bound to the original subject, project and server and expires after its idle timeout. Runs one semantic action or assertion, using the same locator vocabulary as the snapshot.
POST
/
projects
/
{projectId}
/
servers
/
{serverId}
/
widget-sessions
/
{id}
/
scripted-step
Run a retained widget step
curl --request POST \
--url https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step": {
"kind": "click",
"target": {
"role": {
"role": "<string>",
"name": "<string>",
"exact": true
},
"text": "<string>",
"css": "<string>",
"testId": "<string>",
"nth": 1
}
},
"priorWidgetToolCalls": [
{
"name": "<string>",
"args": {},
"ok": true,
"elapsedMs": 123,
"error": "<string>",
"result": "<unknown>",
"visibility": []
}
]
}
'import requests
url = "https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step"
payload = {
"step": {
"kind": "click",
"target": {
"role": {
"role": "<string>",
"name": "<string>",
"exact": True
},
"text": "<string>",
"css": "<string>",
"testId": "<string>",
"nth": 1
}
},
"priorWidgetToolCalls": [
{
"name": "<string>",
"args": {},
"ok": True,
"elapsedMs": 123,
"error": "<string>",
"result": "<unknown>",
"visibility": []
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
step: {
kind: 'click',
target: {
role: {role: '<string>', name: '<string>', exact: true},
text: '<string>',
css: '<string>',
testId: '<string>',
nth: 1
}
},
priorWidgetToolCalls: [
{
name: '<string>',
args: {},
ok: true,
elapsedMs: 123,
error: '<string>',
result: '<unknown>',
visibility: []
}
]
})
};
fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step', 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}/servers/{serverId}/widget-sessions/{id}/scripted-step",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'step' => [
'kind' => 'click',
'target' => [
'role' => [
'role' => '<string>',
'name' => '<string>',
'exact' => true
],
'text' => '<string>',
'css' => '<string>',
'testId' => '<string>',
'nth' => 1
]
],
'priorWidgetToolCalls' => [
[
'name' => '<string>',
'args' => [
],
'ok' => true,
'elapsedMs' => 123,
'error' => '<string>',
'result' => '<unknown>',
'visibility' => [
]
]
]
]),
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}/servers/{serverId}/widget-sessions/{id}/scripted-step"
payload := strings.NewReader("{\n \"step\": {\n \"kind\": \"click\",\n \"target\": {\n \"role\": {\n \"role\": \"<string>\",\n \"name\": \"<string>\",\n \"exact\": true\n },\n \"text\": \"<string>\",\n \"css\": \"<string>\",\n \"testId\": \"<string>\",\n \"nth\": 1\n }\n },\n \"priorWidgetToolCalls\": [\n {\n \"name\": \"<string>\",\n \"args\": {},\n \"ok\": true,\n \"elapsedMs\": 123,\n \"error\": \"<string>\",\n \"result\": \"<unknown>\",\n \"visibility\": []\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step\": {\n \"kind\": \"click\",\n \"target\": {\n \"role\": {\n \"role\": \"<string>\",\n \"name\": \"<string>\",\n \"exact\": true\n },\n \"text\": \"<string>\",\n \"css\": \"<string>\",\n \"testId\": \"<string>\",\n \"nth\": 1\n }\n },\n \"priorWidgetToolCalls\": [\n {\n \"name\": \"<string>\",\n \"args\": {},\n \"ok\": true,\n \"elapsedMs\": 123,\n \"error\": \"<string>\",\n \"result\": \"<unknown>\",\n \"visibility\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"step\": {\n \"kind\": \"click\",\n \"target\": {\n \"role\": {\n \"role\": \"<string>\",\n \"name\": \"<string>\",\n \"exact\": true\n },\n \"text\": \"<string>\",\n \"css\": \"<string>\",\n \"testId\": \"<string>\",\n \"nth\": 1\n }\n },\n \"priorWidgetToolCalls\": [\n {\n \"name\": \"<string>\",\n \"args\": {},\n \"ok\": true,\n \"elapsedMs\": 123,\n \"error\": \"<string>\",\n \"result\": \"<unknown>\",\n \"visibility\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"step": {
"kind": "click",
"target": {
"role": {
"role": "<string>",
"name": "<string>",
"exact": true
},
"text": "<string>",
"css": "<string>",
"testId": "<string>",
"nth": 1
},
"clickType": "left"
},
"ok": true,
"widgetToolCalls": [
{
"name": "<string>",
"args": {},
"ok": true,
"elapsedMs": 123,
"error": "<string>",
"result": "<unknown>",
"visibility": [
"model"
]
}
],
"followUps": [
"<string>"
],
"elapsedMs": 123,
"expiresAt": 123,
"reason": "<string>",
"screenshotBase64": "<string>",
"note": "<string>",
"pluginWorkspace": {}
}
Authorizations
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
ID of the hosted project that contains the server.
ID of the server inside the project.
Session ID returned by this local Inspector.
Body
application/json
Response
The session operation result.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?
⌘I
Run a retained widget step
curl --request POST \
--url https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"step": {
"kind": "click",
"target": {
"role": {
"role": "<string>",
"name": "<string>",
"exact": true
},
"text": "<string>",
"css": "<string>",
"testId": "<string>",
"nth": 1
}
},
"priorWidgetToolCalls": [
{
"name": "<string>",
"args": {},
"ok": true,
"elapsedMs": 123,
"error": "<string>",
"result": "<unknown>",
"visibility": []
}
]
}
'import requests
url = "https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step"
payload = {
"step": {
"kind": "click",
"target": {
"role": {
"role": "<string>",
"name": "<string>",
"exact": True
},
"text": "<string>",
"css": "<string>",
"testId": "<string>",
"nth": 1
}
},
"priorWidgetToolCalls": [
{
"name": "<string>",
"args": {},
"ok": True,
"elapsedMs": 123,
"error": "<string>",
"result": "<unknown>",
"visibility": []
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
step: {
kind: 'click',
target: {
role: {role: '<string>', name: '<string>', exact: true},
text: '<string>',
css: '<string>',
testId: '<string>',
nth: 1
}
},
priorWidgetToolCalls: [
{
name: '<string>',
args: {},
ok: true,
elapsedMs: 123,
error: '<string>',
result: '<unknown>',
visibility: []
}
]
})
};
fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step', 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}/servers/{serverId}/widget-sessions/{id}/scripted-step",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'step' => [
'kind' => 'click',
'target' => [
'role' => [
'role' => '<string>',
'name' => '<string>',
'exact' => true
],
'text' => '<string>',
'css' => '<string>',
'testId' => '<string>',
'nth' => 1
]
],
'priorWidgetToolCalls' => [
[
'name' => '<string>',
'args' => [
],
'ok' => true,
'elapsedMs' => 123,
'error' => '<string>',
'result' => '<unknown>',
'visibility' => [
]
]
]
]),
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}/servers/{serverId}/widget-sessions/{id}/scripted-step"
payload := strings.NewReader("{\n \"step\": {\n \"kind\": \"click\",\n \"target\": {\n \"role\": {\n \"role\": \"<string>\",\n \"name\": \"<string>\",\n \"exact\": true\n },\n \"text\": \"<string>\",\n \"css\": \"<string>\",\n \"testId\": \"<string>\",\n \"nth\": 1\n }\n },\n \"priorWidgetToolCalls\": [\n {\n \"name\": \"<string>\",\n \"args\": {},\n \"ok\": true,\n \"elapsedMs\": 123,\n \"error\": \"<string>\",\n \"result\": \"<unknown>\",\n \"visibility\": []\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"step\": {\n \"kind\": \"click\",\n \"target\": {\n \"role\": {\n \"role\": \"<string>\",\n \"name\": \"<string>\",\n \"exact\": true\n },\n \"text\": \"<string>\",\n \"css\": \"<string>\",\n \"testId\": \"<string>\",\n \"nth\": 1\n }\n },\n \"priorWidgetToolCalls\": [\n {\n \"name\": \"<string>\",\n \"args\": {},\n \"ok\": true,\n \"elapsedMs\": 123,\n \"error\": \"<string>\",\n \"result\": \"<unknown>\",\n \"visibility\": []\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/servers/{serverId}/widget-sessions/{id}/scripted-step")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"step\": {\n \"kind\": \"click\",\n \"target\": {\n \"role\": {\n \"role\": \"<string>\",\n \"name\": \"<string>\",\n \"exact\": true\n },\n \"text\": \"<string>\",\n \"css\": \"<string>\",\n \"testId\": \"<string>\",\n \"nth\": 1\n }\n },\n \"priorWidgetToolCalls\": [\n {\n \"name\": \"<string>\",\n \"args\": {},\n \"ok\": true,\n \"elapsedMs\": 123,\n \"error\": \"<string>\",\n \"result\": \"<unknown>\",\n \"visibility\": []\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"step": {
"kind": "click",
"target": {
"role": {
"role": "<string>",
"name": "<string>",
"exact": true
},
"text": "<string>",
"css": "<string>",
"testId": "<string>",
"nth": 1
},
"clickType": "left"
},
"ok": true,
"widgetToolCalls": [
{
"name": "<string>",
"args": {},
"ok": true,
"elapsedMs": 123,
"error": "<string>",
"result": "<unknown>",
"visibility": [
"model"
]
}
],
"followUps": [
"<string>"
],
"elapsedMs": 123,
"expiresAt": 123,
"reason": "<string>",
"screenshotBase64": "<string>",
"note": "<string>",
"pluginWorkspace": {}
}