Write File

curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/files \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "path": "<string>",
  "data": "<string>",
  "username": "<string>"
}
'

import requests

url = "https://api.declaw.ai/sandboxes/{sandbox_id}/files"

payload = {
    "path": "<string>",
    "data": "<string>",
    "username": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', data: '<string>', username: '<string>'})
};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/files', 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.declaw.ai/sandboxes/{sandbox_id}/files",
  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([
    'path' => '<string>',
    'data' => '<string>',
    'username' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.declaw.ai/sandboxes/{sandbox_id}/files"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"data\": \"<string>\",\n  \"username\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://api.declaw.ai/sandboxes/{sandbox_id}/files")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"data\": \"<string>\",\n  \"username\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.declaw.ai/sandboxes/{sandbox_id}/files")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"data\": \"<string>\",\n  \"username\": \"<string>\"\n}"

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

POST

sandboxes

{sandbox_id}

files

Write File

curl --request POST \
  --url https://api.declaw.ai/sandboxes/{sandbox_id}/files \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "path": "<string>",
  "data": "<string>",
  "username": "<string>"
}
'

import requests

url = "https://api.declaw.ai/sandboxes/{sandbox_id}/files"

payload = {
    "path": "<string>",
    "data": "<string>",
    "username": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({path: '<string>', data: '<string>', username: '<string>'})
};

fetch('https://api.declaw.ai/sandboxes/{sandbox_id}/files', 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.declaw.ai/sandboxes/{sandbox_id}/files",
  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([
    'path' => '<string>',
    'data' => '<string>',
    'username' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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.declaw.ai/sandboxes/{sandbox_id}/files"

	payload := strings.NewReader("{\n  \"path\": \"<string>\",\n  \"data\": \"<string>\",\n  \"username\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://api.declaw.ai/sandboxes/{sandbox_id}/files")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"path\": \"<string>\",\n  \"data\": \"<string>\",\n  \"username\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.declaw.ai/sandboxes/{sandbox_id}/files")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"path\": \"<string>\",\n  \"data\": \"<string>\",\n  \"username\": \"<string>\"\n}"

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

Writes a file to the specified path inside the sandbox. If the file already exists it is overwritten. Parent directories are created automatically if they do not exist. Returns the envd write response.

Path Parameters

string

required

The sandbox identifier. Format: sbx-<8 chars>.

Request Body

string

required

Absolute path to write inside the sandbox. Parent directories are created automatically.Example: "/home/user/script.py"

string

required

File content as a UTF-8 string. This endpoint is text-only — it cannot carry arbitrary bytes. For binary payloads (images, compiled artifacts, base64-decoded blobs) use the streaming PUT /files/raw endpoint with Content-Type: application/octet-stream (500 MiB cap). The Python and TypeScript SDKs dispatch automatically based on payload type — pass bytes / Uint8Array to files.write() and the SDK routes to /files/raw for you.Example: "print('hello')\n"

string

Unix user to own the written file. Defaults to the envd default user.Example: "user"

Response

Returns the envd write confirmation as a JSON object.

Example

curl -X POST https://api.declaw.ai/sandboxes/sbx-a1b2c3d4/files \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "path": "/home/user/script.py",
    "data": "print(\"hello\")\n"
  }'

from declaw import Sandbox

sbx = Sandbox.connect("sbx-a1b2c3d4", api_key="YOUR_API_KEY", domain="api.declaw.ai")
sbx.files.write("/home/user/script.py", "print('hello')\n")

import { Sandbox } from "@declaw/sdk";

const sbx = await Sandbox.connect("sbx-a1b2c3d4", {
  apiKey: "YOUR_API_KEY",
  domain: "api.declaw.ai",
});
await sbx.files.write("/home/user/script.py", "print('hello')\n");

Error Responses

Status	Cause
`400`	Invalid request body
`401`	Missing or invalid API key
`404`	Sandbox not found
`409`	Sandbox is paused — resume it before accessing files
`410`	Sandbox has been killed
`502`	envd daemon unreachable
`503`	Sandbox has no VM

Read File Write File (Raw / Binary)

Sandbox API

Command API

Filesystem API

Volumes API

Write File

Path Parameters

Request Body

Response

Example

Error Responses

​Path Parameters

​Request Body

​Response

​Example

​Error Responses

Path Parameters

Request Body

Response

Example

Error Responses