curl --request PATCH \
--url https://api.getcargo.io/v1/context/runtime/content \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"path": "<string>",
"oldString": "<string>",
"newString": "<string>",
"replaceAll": true,
"commitMessage": "<string>"
}
'import requests
url = "https://api.getcargo.io/v1/context/runtime/content"
payload = {
"path": "<string>",
"oldString": "<string>",
"newString": "<string>",
"replaceAll": True,
"commitMessage": "<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({
path: '<string>',
oldString: '<string>',
newString: '<string>',
replaceAll: true,
commitMessage: '<string>'
})
};
fetch('https://api.getcargo.io/v1/context/runtime/content', 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.getcargo.io/v1/context/runtime/content",
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([
'path' => '<string>',
'oldString' => '<string>',
'newString' => '<string>',
'replaceAll' => true,
'commitMessage' => '<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.getcargo.io/v1/context/runtime/content"
payload := strings.NewReader("{\n \"path\": \"<string>\",\n \"oldString\": \"<string>\",\n \"newString\": \"<string>\",\n \"replaceAll\": true,\n \"commitMessage\": \"<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.getcargo.io/v1/context/runtime/content")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"path\": \"<string>\",\n \"oldString\": \"<string>\",\n \"newString\": \"<string>\",\n \"replaceAll\": true,\n \"commitMessage\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/context/runtime/content")
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 \"path\": \"<string>\",\n \"oldString\": \"<string>\",\n \"newString\": \"<string>\",\n \"replaceAll\": true,\n \"commitMessage\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"commit": {
"sha": "<string>",
"message": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Edit runtime sandbox file
Replace occurrences of oldString with newString in a file in the workspace runtime sandbox, then push the change to the workspace’s default branch on GitHub. By default oldString must occur exactly once; pass replaceAll: true to replace every occurrence. (PATCH /context/runtime/content).
curl --request PATCH \
--url https://api.getcargo.io/v1/context/runtime/content \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"path": "<string>",
"oldString": "<string>",
"newString": "<string>",
"replaceAll": true,
"commitMessage": "<string>"
}
'import requests
url = "https://api.getcargo.io/v1/context/runtime/content"
payload = {
"path": "<string>",
"oldString": "<string>",
"newString": "<string>",
"replaceAll": True,
"commitMessage": "<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({
path: '<string>',
oldString: '<string>',
newString: '<string>',
replaceAll: true,
commitMessage: '<string>'
})
};
fetch('https://api.getcargo.io/v1/context/runtime/content', 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.getcargo.io/v1/context/runtime/content",
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([
'path' => '<string>',
'oldString' => '<string>',
'newString' => '<string>',
'replaceAll' => true,
'commitMessage' => '<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.getcargo.io/v1/context/runtime/content"
payload := strings.NewReader("{\n \"path\": \"<string>\",\n \"oldString\": \"<string>\",\n \"newString\": \"<string>\",\n \"replaceAll\": true,\n \"commitMessage\": \"<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.getcargo.io/v1/context/runtime/content")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"path\": \"<string>\",\n \"oldString\": \"<string>\",\n \"newString\": \"<string>\",\n \"replaceAll\": true,\n \"commitMessage\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.getcargo.io/v1/context/runtime/content")
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 \"path\": \"<string>\",\n \"oldString\": \"<string>\",\n \"newString\": \"<string>\",\n \"replaceAll\": true,\n \"commitMessage\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"commit": {
"sha": "<string>",
"message": "<string>"
}
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}{
"errorMessage": "<string>",
"reason": "<string>"
}Authorizations
API token from cargo-ai login. Send as Authorization: Bearer <token>.
Headers
Client-generated key that makes this write safe to retry. Reusing the same key with the same request returns the original response instead of creating a second record. Reusing it with a different request returns 422. A concurrent retry while the first request is still running returns 409. Keys expire after 24 hours. Not accepted on multipart file uploads. Optional: a request without one is processed as it always was.
255"8e03978e-40d5-43e8-bc93-6894a57f9324"
Body
Edit a file in the workspace runtime sandbox via string replacement, then push the change to the default branch.
Path of the file to edit, relative to the workspace working directory.
1The exact substring to replace. Must occur exactly once unless replaceAll is true.
1Replacement string. May be empty to delete the match. Must differ from oldString.
When true, replace every occurrence of oldString instead of requiring a single match.
Optional commit message override. Defaults to 'context(runtime): edit '.
1Response
Edit runtime sandbox file
Show child attributes
Show child attributes
Was this page helpful?

