Update a sandbox image - MCPJam Inspector

PATCH

/

projects

/

{projectId}

/

images

/

{imageId}

Update a sandbox image

curl --request PATCH \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "scraper (v2)"
}
'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}"

payload = { "name": "scraper (v2)" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}', 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}/images/{imageId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'scraper (v2)'
  ]),
  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}/images/{imageId}"

	payload := strings.NewReader("{\n  \"name\": \"scraper (v2)\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"scraper (v2)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}")

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

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

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

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "contentHash": "<string>",
  "isOwner": true,
  "currentBuild": {
    "id": "<string>",
    "baseImageDigests": [
      "<string>"
    ],
    "createdAt": 123,
    "e2bBuildId": "<string>",
    "logPreview": "<string>",
    "error": "<string>",
    "startedAt": 123,
    "finishedAt": 123
  },
  "createdAt": 123,
  "updatedAt": 123,
  "blueprint": "<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.

imageId

string

required

Sandbox image ID, as returned by the project's image list.

Body

application/json

Option 1
Option 2

Edit a sandbox image. Provide at least one of name or blueprint; only the fields you pass change.

name

string

required

New display name; must be non-empty after trimming.

Minimum string length: 1

blueprint

string

Replacement blueprint YAML. Edits to maintenance/knowledge take effect at the next chat turn without a rebuild; base/initialize edits require a new build.

Minimum string length: 1

Response

The updated sandbox image.

A project's custom Computer image: a digest-pinned blueprint plus its latest build.

id

string

required

projectId

string

required

name

string

required

contentHash

string

required

user = a personal draft; project = shared with the whole project.

Available options:

user,

project

isOwner

boolean

required

currentBuild

object | null

required

One build of a sandbox image's image.

Show child attributes

createdAt

number

required

updatedAt

number

required

blueprint

string

required

The image's blueprint YAML (base / initialize / maintenance / knowledge). base must be an allowlisted official image pinned by sha256 digest.

⌘I

Update a sandbox image

curl --request PATCH \
  --url https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "scraper (v2)"
}
'

import requests

url = "https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}"

payload = { "name": "scraper (v2)" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

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

fetch('https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}', 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}/images/{imageId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'scraper (v2)'
  ]),
  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}/images/{imageId}"

	payload := strings.NewReader("{\n  \"name\": \"scraper (v2)\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"scraper (v2)\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.mcpjam.com/api/v1/projects/{projectId}/images/{imageId}")

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

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

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

{
  "id": "<string>",
  "projectId": "<string>",
  "name": "<string>",
  "contentHash": "<string>",
  "isOwner": true,
  "currentBuild": {
    "id": "<string>",
    "baseImageDigests": [
      "<string>"
    ],
    "createdAt": 123,
    "e2bBuildId": "<string>",
    "logPreview": "<string>",
    "error": "<string>",
    "startedAt": 123,
    "finishedAt": 123
  },
  "createdAt": 123,
  "updatedAt": 123,
  "blueprint": "<string>"
}