> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.runtype.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.runtype.com/_mcp/server.

# Deploy Daytona sandbox

POST https://api.runtype.com/v1/tools/sandbox/deploy
Content-Type: application/json

Deploy a live Daytona preview. Retention defaults to 10m; provider sleep or deletion can end availability earlier. Preview URLs are not durable hosting.

Reference: https://docs.runtype.com/api-reference/runtype-api/tools/deploy-daytona-sandbox

## Authentication

- `Authorization` header (bearer token, required) — API key or Clerk session token

## Servers

- `https://api.runtype.com` (Production, default)
- `https://api.runtype-staging.com` (Staging)

## Request

### Body (application/json)

This endpoint expects an object.

- `code` (string, required)
- `autoDeleteInterval` (integer, optional)
- `autoStopInterval` (integer, optional)
- `files` (map from string to string, optional)
- `labels` (map from string to string, optional)
- `language` (enum, optional)
  - Allowed values: `javascript`, `typescript`, `python`
- `managed` (boolean, optional)
- `packageJson` (string, optional)
- `port` (integer, optional)
- `retention` (enum, optional)
  - Allowed values: `10m`, `1h`, `24h`, `unlimited`
- `sandboxId` (string, optional)
- `sleepPolicy` (V1ToolsSandboxDeployPostRequestBodyContentApplicationJsonSchemaSleepPolicy, optional)
- `startCommand` (string, optional)

## Response

### 200

Sandbox deployment result

- `status` (string, required)
- `effectivePolicy` (V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicy, optional)
- `error` (string, optional)
- `output` (string, optional)
- `previewUrl` (string, optional)
- `sandboxId` (string, optional)

## Errors

### 400 Bad Request Error

Validation error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 401 Unauthorized Error

Unauthorized

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 403 Forbidden Error

Insufficient permissions

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 404 Not Found Error

Sandbox not found

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 500 Internal Server Error

Internal server error

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

### 503 Service Unavailable Error

Sandbox metering unavailable

- `error` (string, required)
- `code` (string, optional) — Stable error code. `insufficient_scope` marks an API key that lacks a scope this request needs.
- `details` (list of ErrorDetailsItems, optional)
- `requiredScopes` (list of string, optional) — On `insufficient_scope`: every API key scope this request needs.

## Types

### V1ToolsSandboxDeployPostRequestBodyContentApplicationJsonSchemaSleepPolicy

- V1ToolsSandboxDeployPostRequestBodyContentApplicationJsonSchemaSleepPolicy0
- V1ToolsSandboxDeployPostRequestBodyContentApplicationJsonSchemaSleepPolicy1

### V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicy

- `expiresAt` (string, required, nullable)
- `metering` (enum, required)
  - Allowed values: `active`, `legacy-untracked`
- `origin` (enum, required)
  - Allowed values: `explicit`, `legacy-default`
- `retention` (enum, required)
  - Allowed values: `10m`, `1h`, `24h`, `unlimited`
- `autoDeleteInterval` (double, optional)
- `autoStopInterval` (double, optional)
- `containerEpoch` (integer, optional) — Runtype Sandbox: the container epoch the preview URL is bound to; a new epoch mints a new URL.
- `freshContainer` (boolean, optional) — Runtype Sandbox: true when this deploy started a new container rather than reusing a running one.
- `previewUrlChanged` (boolean, optional) — Runtype Sandbox: true when the preview URL differs from the one the previous successful deploy to this sandbox returned. Re-register any saved copy of the old URL. False for a first deploy.
- `sleepPolicy` (V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicySleepPolicy, optional)

### ErrorDetailsItems

- `message` (string, required)
- `code` (string, optional) — Stable Runtype validation code (e.g. MISSING_REQUIRED_FIELD, INVALID_ENUM).
- `path` (string, optional) — Dotted JSON path to the offending field.
- `suggestion` (string, optional) — Actionable hint (allowed values, accepted range, …).

### V1ToolsSandboxDeployPostRequestBodyContentApplicationJsonSchemaSleepPolicy0

- `mode` (enum, required)
  - Allowed values: `never`

### V1ToolsSandboxDeployPostRequestBodyContentApplicationJsonSchemaSleepPolicy1

- `after` (enum, required)
  - Allowed values: `5m`, `15m`, `30m`, `1h`
- `mode` (enum, required)
  - Allowed values: `idle`

### V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicySleepPolicy

- V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicySleepPolicy0
- V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicySleepPolicy1

### V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicySleepPolicy0

- `mode` (enum, required)
  - Allowed values: `never`

### V1ToolsSandboxDeployPostResponsesContentApplicationJsonSchemaEffectivePolicySleepPolicy1

- `after` (enum, required)
  - Allowed values: `5m`, `15m`, `30m`, `1h`
- `mode` (enum, required)
  - Allowed values: `idle`

## Examples

**Request**

```json
{
  "code": "const express = require('express');\nconst app = express();\napp.get('/', (req, res) => res.send('Hello'));\napp.listen(3000);",
  "language": "javascript",
  "port": 3000
}
```

**Response**

```json
{
  "status": "string",
  "effectivePolicy": {
    "expiresAt": "string",
    "metering": "active",
    "origin": "explicit",
    "retention": "10m",
    "autoDeleteInterval": 1.1,
    "autoStopInterval": 1.1,
    "containerEpoch": 1,
    "freshContainer": true,
    "previewUrlChanged": true,
    "sleepPolicy": {
      "mode": "never"
    }
  },
  "error": "string",
  "output": "string",
  "previewUrl": "string",
  "sandboxId": "string"
}
```

**SDK Code**

```python Deploy Sandbox
import requests

url = "https://api.runtype.com/v1/tools/sandbox/deploy"

payload = {
    "code": "const express = require('express');
const app = express();
app.get('/', (req, res) => res.send('Hello'));
app.listen(3000);",
    "language": "javascript",
    "port": 3000
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Deploy Sandbox
const url = 'https://api.runtype.com/v1/tools/sandbox/deploy';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"code":"const express = require(\'express\');\nconst app = express();\napp.get(\'/\', (req, res) => res.send(\'Hello\'));\napp.listen(3000);","language":"javascript","port":3000}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Deploy Sandbox
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.runtype.com/v1/tools/sandbox/deploy"

	payload := strings.NewReader("{\n  \"code\": \"const express = require('express');\\nconst app = express();\\napp.get('/', (req, res) => res.send('Hello'));\\napp.listen(3000);\",\n  \"language\": \"javascript\",\n  \"port\": 3000\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(res)
	fmt.Println(string(body))

}
```

```ruby Deploy Sandbox
require 'uri'
require 'net/http'

url = URI("https://api.runtype.com/v1/tools/sandbox/deploy")

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  \"code\": \"const express = require('express');\\nconst app = express();\\napp.get('/', (req, res) => res.send('Hello'));\\napp.listen(3000);\",\n  \"language\": \"javascript\",\n  \"port\": 3000\n}"

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

```java Deploy Sandbox
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.runtype.com/v1/tools/sandbox/deploy")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"code\": \"const express = require('express');\\nconst app = express();\\napp.get('/', (req, res) => res.send('Hello'));\\napp.listen(3000);\",\n  \"language\": \"javascript\",\n  \"port\": 3000\n}")
  .asString();
```

```php Deploy Sandbox
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.runtype.com/v1/tools/sandbox/deploy', [
  'body' => '{
  "code": "const express = require(\'express\');\\nconst app = express();\\napp.get(\'/\', (req, res) => res.send(\'Hello\'));\\napp.listen(3000);",
  "language": "javascript",
  "port": 3000
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Deploy Sandbox
using RestSharp;

var client = new RestClient("https://api.runtype.com/v1/tools/sandbox/deploy");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"code\": \"const express = require('express');\\nconst app = express();\\napp.get('/', (req, res) => res.send('Hello'));\\napp.listen(3000);\",\n  \"language\": \"javascript\",\n  \"port\": 3000\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Deploy Sandbox
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "code": "const express = require('express');
const app = express();
app.get('/', (req, res) => res.send('Hello'));
app.listen(3000);",
  "language": "javascript",
  "port": 3000
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.runtype.com/v1/tools/sandbox/deploy")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```