Update a session
Update a session: archive or restore it, set priority, rename it, change agent/model, switch between Build (normal) and Plan (planning) modes, or configure its workspace and branches. Share it through its sharing subresource; the deprecated visibility field remains for older clients. Archiving uses level=0; restoring archived sessions uses level=1 and does not restart work. Use pins to pin or unpin sessions. Submit memoryMb alone to request asynchronous memory growth for a running adaptive sandbox within project limits; sandbox metrics report progress.
import Tembo from '@tembo-io/sdk';
const client = new Tembo();
const session = await client.sessions.update('7c9e6679-7425-40de-944b-e07fc1f90ae7', {});use tembo_rs::*;
let client = Tembo::from_env()?;
let response = client
.sessions()
.update("7c9e6679-7425-40de-944b-e07fc1f90ae7", SessionsUpdateBody::new())
.send()
.await?;
curl --request PATCH \
--url https://api.tembo.io/v1/sessions/{sessionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"memoryMb": 66048,
"agent": "<string>",
"agentOptions": {
"reasoningLevel": "<string>",
"goal": {
"enabled": true,
"objective": "<string>"
},
"ultracode": true
},
"baseBranch": "<string>",
"branchName": "<string>",
"description": "<string>",
"richContent": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello"
}
]
}
]
},
"level": 50,
"mcpServers": [
"<string>"
],
"projectId": "<string>",
"targetBranch": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.tembo.io/v1/sessions/{sessionId}"
payload = {
"memoryMb": 66048,
"agent": "<string>",
"agentOptions": {
"reasoningLevel": "<string>",
"goal": {
"enabled": True,
"objective": "<string>"
},
"ultracode": True
},
"baseBranch": "<string>",
"branchName": "<string>",
"description": "<string>",
"richContent": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello"
}
]
}
]
},
"level": 50,
"mcpServers": ["<string>"],
"projectId": "<string>",
"targetBranch": "<string>",
"title": "<string>"
}
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({
memoryMb: 66048,
agent: '<string>',
agentOptions: {
reasoningLevel: '<string>',
goal: {enabled: true, objective: '<string>'},
ultracode: true
},
baseBranch: '<string>',
branchName: '<string>',
description: '<string>',
richContent: {
type: 'doc',
content: [{type: 'paragraph', content: [{type: 'text', text: 'Hello'}]}]
},
level: 50,
mcpServers: ['<string>'],
projectId: '<string>',
targetBranch: '<string>',
title: '<string>'
})
};
fetch('https://api.tembo.io/v1/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://api.tembo.io/v1/sessions/{sessionId}",
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([
'memoryMb' => 66048,
'agent' => '<string>',
'agentOptions' => [
'reasoningLevel' => '<string>',
'goal' => [
'enabled' => true,
'objective' => '<string>'
],
'ultracode' => true
],
'baseBranch' => '<string>',
'branchName' => '<string>',
'description' => '<string>',
'richContent' => [
'type' => 'doc',
'content' => [
[
'type' => 'paragraph',
'content' => [
[
'type' => 'text',
'text' => 'Hello'
]
]
]
]
],
'level' => 50,
'mcpServers' => [
'<string>'
],
'projectId' => '<string>',
'targetBranch' => '<string>',
'title' => '<string>'
]),
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://api.tembo.io/v1/sessions/{sessionId}"
payload := strings.NewReader("{\n \"memoryMb\": 66048,\n \"agent\": \"<string>\",\n \"agentOptions\": {\n \"reasoningLevel\": \"<string>\",\n \"goal\": {\n \"enabled\": true,\n \"objective\": \"<string>\"\n },\n \"ultracode\": true\n },\n \"baseBranch\": \"<string>\",\n \"branchName\": \"<string>\",\n \"description\": \"<string>\",\n \"richContent\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\"\n }\n ]\n }\n ]\n },\n \"level\": 50,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"targetBranch\": \"<string>\",\n \"title\": \"<string>\"\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://api.tembo.io/v1/sessions/{sessionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"memoryMb\": 66048,\n \"agent\": \"<string>\",\n \"agentOptions\": {\n \"reasoningLevel\": \"<string>\",\n \"goal\": {\n \"enabled\": true,\n \"objective\": \"<string>\"\n },\n \"ultracode\": true\n },\n \"baseBranch\": \"<string>\",\n \"branchName\": \"<string>\",\n \"description\": \"<string>\",\n \"richContent\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\"\n }\n ]\n }\n ]\n },\n \"level\": 50,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"targetBranch\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tembo.io/v1/sessions/{sessionId}")
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 \"memoryMb\": 66048,\n \"agent\": \"<string>\",\n \"agentOptions\": {\n \"reasoningLevel\": \"<string>\",\n \"goal\": {\n \"enabled\": true,\n \"objective\": \"<string>\"\n },\n \"ultracode\": true\n },\n \"baseBranch\": \"<string>\",\n \"branchName\": \"<string>\",\n \"description\": \"<string>\",\n \"richContent\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\"\n }\n ]\n }\n ]\n },\n \"level\": 50,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"targetBranch\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactType": "PullRequest",
"baseBranch": "<string>",
"branchName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"externalUrl": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"lastQueuedAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z",
"level": 0,
"mode": "normal",
"parentSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "<string>",
"sandboxSize": "nano",
"sessionType": "Chat",
"targetBranch": "<string>",
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"visibility": "private",
"artifacts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "PullRequest",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pullRequests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"title": "<string>",
"status": "open",
"isDraft": true,
"sourceBranch": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"agent": "<string>",
"diff": {
"additions": 4503599627370495,
"deletions": 4503599627370495,
"data": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"baseBranch": "<string>",
"headSha": "<string>",
"author": {
"avatarUrl": "<string>",
"login": "<string>"
},
"codeRepository": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "<string>",
"baseBranch": "<string>",
"provider": "<string>"
}
}
]
}
],
"automaticSizing": true,
"description": "<string>",
"diffSummary": {
"additions": 0,
"deletions": 0
},
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"htmlUrl": "<string>",
"isPinned": true,
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"icon": "folder",
"color": "neutral"
},
"sessionSource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"repositories": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"provider": "<string>"
}
]
},
"sourcePullRequest": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"title": "<string>",
"status": "open",
"isDraft": true
},
"state": {
"isQueued": true,
"isCancelled": true,
"isCompleted": true,
"isFailed": true,
"inProgress": true,
"current": "inProgress"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Path Parameters
Body
Request in-place memory growth for a running adaptive sandbox, within project limits. Submit separately from other session changes. Returns the session while the resize runs asynchronously; sandbox metrics report its progress.
1024 <= x <= 131072Must be a multiple of 1024Replace the initial prompt rich-text document, or null to clear it. Only the session creator can change it.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
{
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [{ "type": "text", "text": "Hello" }]
}
]
}
Response
Update a session
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Was this page helpful?
import Tembo from '@tembo-io/sdk';
const client = new Tembo();
const session = await client.sessions.update('7c9e6679-7425-40de-944b-e07fc1f90ae7', {});use tembo_rs::*;
let client = Tembo::from_env()?;
let response = client
.sessions()
.update("7c9e6679-7425-40de-944b-e07fc1f90ae7", SessionsUpdateBody::new())
.send()
.await?;
curl --request PATCH \
--url https://api.tembo.io/v1/sessions/{sessionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"memoryMb": 66048,
"agent": "<string>",
"agentOptions": {
"reasoningLevel": "<string>",
"goal": {
"enabled": true,
"objective": "<string>"
},
"ultracode": true
},
"baseBranch": "<string>",
"branchName": "<string>",
"description": "<string>",
"richContent": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello"
}
]
}
]
},
"level": 50,
"mcpServers": [
"<string>"
],
"projectId": "<string>",
"targetBranch": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.tembo.io/v1/sessions/{sessionId}"
payload = {
"memoryMb": 66048,
"agent": "<string>",
"agentOptions": {
"reasoningLevel": "<string>",
"goal": {
"enabled": True,
"objective": "<string>"
},
"ultracode": True
},
"baseBranch": "<string>",
"branchName": "<string>",
"description": "<string>",
"richContent": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Hello"
}
]
}
]
},
"level": 50,
"mcpServers": ["<string>"],
"projectId": "<string>",
"targetBranch": "<string>",
"title": "<string>"
}
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({
memoryMb: 66048,
agent: '<string>',
agentOptions: {
reasoningLevel: '<string>',
goal: {enabled: true, objective: '<string>'},
ultracode: true
},
baseBranch: '<string>',
branchName: '<string>',
description: '<string>',
richContent: {
type: 'doc',
content: [{type: 'paragraph', content: [{type: 'text', text: 'Hello'}]}]
},
level: 50,
mcpServers: ['<string>'],
projectId: '<string>',
targetBranch: '<string>',
title: '<string>'
})
};
fetch('https://api.tembo.io/v1/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://api.tembo.io/v1/sessions/{sessionId}",
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([
'memoryMb' => 66048,
'agent' => '<string>',
'agentOptions' => [
'reasoningLevel' => '<string>',
'goal' => [
'enabled' => true,
'objective' => '<string>'
],
'ultracode' => true
],
'baseBranch' => '<string>',
'branchName' => '<string>',
'description' => '<string>',
'richContent' => [
'type' => 'doc',
'content' => [
[
'type' => 'paragraph',
'content' => [
[
'type' => 'text',
'text' => 'Hello'
]
]
]
]
],
'level' => 50,
'mcpServers' => [
'<string>'
],
'projectId' => '<string>',
'targetBranch' => '<string>',
'title' => '<string>'
]),
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://api.tembo.io/v1/sessions/{sessionId}"
payload := strings.NewReader("{\n \"memoryMb\": 66048,\n \"agent\": \"<string>\",\n \"agentOptions\": {\n \"reasoningLevel\": \"<string>\",\n \"goal\": {\n \"enabled\": true,\n \"objective\": \"<string>\"\n },\n \"ultracode\": true\n },\n \"baseBranch\": \"<string>\",\n \"branchName\": \"<string>\",\n \"description\": \"<string>\",\n \"richContent\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\"\n }\n ]\n }\n ]\n },\n \"level\": 50,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"targetBranch\": \"<string>\",\n \"title\": \"<string>\"\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://api.tembo.io/v1/sessions/{sessionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"memoryMb\": 66048,\n \"agent\": \"<string>\",\n \"agentOptions\": {\n \"reasoningLevel\": \"<string>\",\n \"goal\": {\n \"enabled\": true,\n \"objective\": \"<string>\"\n },\n \"ultracode\": true\n },\n \"baseBranch\": \"<string>\",\n \"branchName\": \"<string>\",\n \"description\": \"<string>\",\n \"richContent\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\"\n }\n ]\n }\n ]\n },\n \"level\": 50,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"targetBranch\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.tembo.io/v1/sessions/{sessionId}")
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 \"memoryMb\": 66048,\n \"agent\": \"<string>\",\n \"agentOptions\": {\n \"reasoningLevel\": \"<string>\",\n \"goal\": {\n \"enabled\": true,\n \"objective\": \"<string>\"\n },\n \"ultracode\": true\n },\n \"baseBranch\": \"<string>\",\n \"branchName\": \"<string>\",\n \"description\": \"<string>\",\n \"richContent\": {\n \"type\": \"doc\",\n \"content\": [\n {\n \"type\": \"paragraph\",\n \"content\": [\n {\n \"type\": \"text\",\n \"text\": \"Hello\"\n }\n ]\n }\n ]\n },\n \"level\": 50,\n \"mcpServers\": [\n \"<string>\"\n ],\n \"projectId\": \"<string>\",\n \"targetBranch\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": "<string>",
"agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"artifactType": "PullRequest",
"baseBranch": "<string>",
"branchName": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"externalId": "<string>",
"externalUrl": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"kind": "<string>",
"lastQueuedAt": "2023-11-07T05:31:56Z",
"lastSeenAt": "2023-11-07T05:31:56Z",
"level": 0,
"mode": "normal",
"parentSessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"projectId": "<string>",
"sandboxSize": "nano",
"sessionType": "Chat",
"targetBranch": "<string>",
"title": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"visibility": "private",
"artifacts": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "PullRequest",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"pullRequests": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"title": "<string>",
"status": "open",
"isDraft": true,
"sourceBranch": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"agent": "<string>",
"diff": {
"additions": 4503599627370495,
"deletions": 4503599627370495,
"data": "<string>"
},
"updatedAt": "2023-11-07T05:31:56Z",
"baseBranch": "<string>",
"headSha": "<string>",
"author": {
"avatarUrl": "<string>",
"login": "<string>"
},
"codeRepository": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"owner": "<string>",
"baseBranch": "<string>",
"provider": "<string>"
}
}
]
}
],
"automaticSizing": true,
"description": "<string>",
"diffSummary": {
"additions": 0,
"deletions": 0
},
"folderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"htmlUrl": "<string>",
"isPinned": true,
"project": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"icon": "folder",
"color": "neutral"
},
"sessionSource": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"type": "<string>",
"repositories": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"provider": "<string>"
}
]
},
"sourcePullRequest": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"url": "<string>",
"title": "<string>",
"status": "open",
"isDraft": true
},
"state": {
"isQueued": true,
"isCancelled": true,
"isCompleted": true,
"isFailed": true,
"inProgress": true,
"current": "inProgress"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}