Fork box - ascii

POST

boxes

{boxId}

fork

Fork box

curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/fork \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "env": {},
  "environment": "base",
  "noEnv": true,
  "ttlSeconds": 3600
}
'

import requests

url = "https://ascii.dev/api/box/v1/boxes/{boxId}/fork"

payload = {
    "env": {},
    "environment": "base",
    "noEnv": True,
    "ttlSeconds": 3600
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({env: {}, environment: 'base', noEnv: true, ttlSeconds: 3600})
};

fetch('https://ascii.dev/api/box/v1/boxes/{boxId}/fork', 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://ascii.dev/api/box/v1/boxes/{boxId}/fork",
  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([
    'env' => [
        
    ],
    'environment' => 'base',
    'noEnv' => true,
    'ttlSeconds' => 3600
  ]),
  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://ascii.dev/api/box/v1/boxes/{boxId}/fork"

	payload := strings.NewReader("{\n  \"env\": {},\n  \"environment\": \"base\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 3600\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://ascii.dev/api/box/v1/boxes/{boxId}/fork")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"env\": {},\n  \"environment\": \"base\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/boxes/{boxId}/fork")

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  \"env\": {},\n  \"environment\": \"base\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 3600\n}"

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

{
  "ok": true,
  "type": "box.forking",
  "id": "bx_abcdef23",
  "status": "forking",
  "box": {
    "id": "bx_abcdef23",
    "name": "Box fork",
    "state": "provisioning",
    "desktopAvailable": false,
    "snapshotAvailable": false
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

Box bearer token in the form box_.... Service API keys authenticate Box operations.

Headers

Idempotency-Key

string

Optional exactly-once key for creating a box. Send your own opaque, account-unique value (a UUID) to make POST /boxes safe to retry when the response is lost (network timeout, 5xx): the first request creates the box and binds it to the key; every later request with the same account, key, and request body returns that same box instead of creating a second, billable one. Behavior: keys are retained for 24 hours; a concurrent or early retry while the first box is still being minted returns 409 idempotency_in_progress (retry shortly, same key); reusing a key with a different body returns 409 idempotency_key_reused; timeouts and 5xx are safe to retry with the same key; a create that fails before the box exists releases the key within ~2 minutes so a retry can create the box. Omit the header to keep the default (non-idempotent) behavior.

Maximum string length: 255

Path Parameters

boxId

string

required

Public Box id returned by create/list/get box calls.

Pattern: ^bx_[23456789abcdefghjkmnpqrstuvwxyz]{8}$

Body

application/json

env

object

Replaces the env the fork would otherwise inherit from the source box. Same validation rules as CreateBoxRequest.env.

Show child attributes

environment

string

Optionally pin the fork to a different named Box environment. Omit to inherit the source box's environment. Unknown names are rejected with unknown_environment.

Examples:

"base"

"customer-demos"

noEnv

boolean

Make the fork no-env (see CreateBoxRequest.noEnv). A fork of a no-env box is always no-env regardless of this field.

type

enum<string>

Machine size for the fork. Omit to inherit the source box's type. The source box is never modified. Shrinking is rejected with type_too_small when the source's data would not fit the smaller disk. xlarge requires the effective $100 plan or higher and an explicit bare-metal operator allocation.

Available options:

small,

default,

large,

xlarge

ttlSeconds

integer | null

default:3600

Auto-stop for the fork, in seconds. Omit for the 1 hour default; the fork does NOT inherit the source box's TTL, so forking a Box that has auto-stop disabled still gives you a fork that stops itself. null disables auto-stop, which means nothing will ever stop this Box for you.

Required range: 1 <= x <= 2592000

Response

Fork started. The response id is the new forked box id.

boolean

required

Example:

true

type

string

required

Stable success envelope discriminator added by v1.

Example:

"box.stopping"

string

required

status

string

required

Example:

"archiving"

box

object | null

Show child attributes

Fork box

curl --request POST \
  --url https://ascii.dev/api/box/v1/boxes/{boxId}/fork \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "env": {},
  "environment": "base",
  "noEnv": true,
  "ttlSeconds": 3600
}
'

import requests

url = "https://ascii.dev/api/box/v1/boxes/{boxId}/fork"

payload = {
    "env": {},
    "environment": "base",
    "noEnv": True,
    "ttlSeconds": 3600
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({env: {}, environment: 'base', noEnv: true, ttlSeconds: 3600})
};

fetch('https://ascii.dev/api/box/v1/boxes/{boxId}/fork', 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://ascii.dev/api/box/v1/boxes/{boxId}/fork",
  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([
    'env' => [
        
    ],
    'environment' => 'base',
    'noEnv' => true,
    'ttlSeconds' => 3600
  ]),
  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://ascii.dev/api/box/v1/boxes/{boxId}/fork"

	payload := strings.NewReader("{\n  \"env\": {},\n  \"environment\": \"base\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 3600\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://ascii.dev/api/box/v1/boxes/{boxId}/fork")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"env\": {},\n  \"environment\": \"base\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 3600\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ascii.dev/api/box/v1/boxes/{boxId}/fork")

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  \"env\": {},\n  \"environment\": \"base\",\n  \"noEnv\": true,\n  \"ttlSeconds\": 3600\n}"

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

{
  "ok": true,
  "type": "box.forking",
  "id": "bx_abcdef23",
  "status": "forking",
  "box": {
    "id": "bx_abcdef23",
    "name": "Box fork",
    "state": "provisioning",
    "desktopAvailable": false,
    "snapshotAvailable": false
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}

{
  "ok": false,
  "type": "box.error",
  "status": 409,
  "code": "provider_not_configured",
  "message": "Prompting is locked until Codex is configured on the Agents page.",
  "requestId": "req_01HX...",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "status": 123,
    "details": {}
  }
}