Write process input

curl --request POST \
  --url https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "yes\n"
}
'

import requests

url = "https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin"

payload = { "data": "yes
" }
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({data: 'yes\n'})
};

fetch('https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin', 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.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin",
  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([
    'data' => 'yes
'
  ]),
  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.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin"

	payload := strings.NewReader("{\n  \"data\": \"yes\\n\"\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://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": \"yes\\n\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin")

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  \"data\": \"yes\\n\"\n}"

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

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

Processes

Write Process Input

You can rely on:

Input is delivered in order.
EOF is explicit.
Uncertain delivery is never resent.
Input is UTF-8 text on every route.

You can set: data (text), EOF.

Not promised: chunking on the wire.

Append text to a process started with stdin: true. Calls from one client must be awaited sequentially to preserve input order. The selected route must support both processes.input and input after process reconnection (reattached_stdin); otherwise writes and EOF are refused as unsupported_feature before dispatch. Use POST /sandboxes/match with requirements.processes.input set to true to inspect eligible routes before create. If stdin is closed, return 409.

Write process input

curl --request POST \
  --url https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": "yes\n"
}
'

import requests

url = "https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin"

payload = { "data": "yes
" }
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({data: 'yes\n'})
};

fetch('https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin', 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.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin",
  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([
    'data' => 'yes
'
  ]),
  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.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin"

	payload := strings.NewReader("{\n  \"data\": \"yes\\n\"\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://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": \"yes\\n\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.boxrouter.ai/api/v1/sandboxes/{sandbox_id}/processes/{process_id}/stdin")

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  \"data\": \"yes\\n\"\n}"

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

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "request_id": "<string>",
    "outcome": "not_started",
    "retry": "safe",
    "retry_after_seconds": 1,
    "details": {
      "selection_version": 1,
      "considered": 1,
      "excluded": [
        {
          "provider": "<string>"
        }
      ],
      "closest": {},
      "nearest": [
        {}
      ],
      "requirement": "<string>",
      "purchase_id": "<string>",
      "preview": {
        "unused": 1,
        "held_excluded": 1,
        "fee": 1,
        "principal": 1,
        "tax": 1,
        "total": 1,
        "card": {
          "brand": "<string>",
          "last4": "<string>",
          "type": "card",
          "email": "jsmith@example.com"
        }
      },
      "quote": {
        "amount": 2,
        "tax": 1,
        "total": 2,
        "address_required": true,
        "fee_minor": 1,
        "missing": [
          "<string>"
        ]
      },
      "redemption": {
        "code": "<string>",
        "amount_nanodollars": "<string>",
        "description": "<string>",
        "redeemed_at": "2023-11-07T05:31:56Z"
      },
      "scope": "workspace",
      "period": "total",
      "limit_nanodollars": 2,
      "requested_nanodollars": 2,
      "sign_in_method": "<string>",
      "masked_email": "<string>",
      "failure_reason": "<string>",
      "names": [
        "<string>"
      ],
      "fields": [
        "preferences.order"
      ],
      "volume_id": "<string>",
      "writer_sandbox_id": "<string>",
      "checkpoint": 2,
      "limit_bytes": 1,
      "observed_bytes": 1,
      "mismatch": {
        "field": "image",
        "recorded": "<string>",
        "requested": "<string>"
      },
      "volume_phase": "check",
      "phase": "code",
      "command": "<string>",
      "exit_code": 123,
      "stderr_tail": "<string>",
      "stdout_tail": "<string>",
      "agent": "<string>",
      "port": 32768,
      "revoked": true,
      "preview_id": "<string>",
      "url": "<string>"
    },
    "doc_url": "<string>",
    "fix": "<string>",
    "operation_id": "<string>",
    "provider": "<string>",
    "native_code": "<string>",
    "native_status": 123,
    "native_message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

BoxRouter API key; never an upstream provider key.

Headers

Idempotency-Key

string

Optional for this operation. Preserve the same stable identifier when retrying an uncertain response; never reuse it for new work. If omitted where allowed, Cloud generates a request-scoped key that cannot reconcile a later retry. Do not include credentials or payloads. Stable identifier for one logical mutation.

Required string length: 1 - 128

Path Parameters

sandbox_id

string

required

Workspace-owned BoxRouter sandbox ID, not an upstream ID.

Minimum string length: 1

Pattern: ^[^\u0000]*$

process_id

string

required

Durable BoxRouter process ID owned by the addressed sandbox and workspace.

Minimum string length: 1

Body

application/json

data

string

required

UTF-8 text to append exactly once; does not implicitly append a newline or send EOF.

Response

Input accepted by the provider; application consumption is not guaranteed.

Overview

Sandboxes

Commands

Processes

Files

Terminals

Previews

Volumes

Images

Operations

Routing Settings

Providers

Price Versions

Agent Catalog

Agent Launches

Launch Runs

Workspace Secrets

Artifacts

GitHub

GitHub Actions

Provider Accounts

Credits and Billing

Spend Limits

Write Process Input

Authorizations

Headers

Path Parameters

Body

Response