Write files

Writes one or several files in one call. A retry with the same Idempotency-Key gets the first result.

PUT/v1/sandboxes/{id}/files

Authorization

AuthorizationBearer token (ibk_<public id>_<secret>) · headerrequired

A lane's API key. The lane is taken from the key, never from the request.

Path parameters

idstringrequired

A sandbox id: sbx_ and a random part, at most 64 characters.

max length 64 · matches ^sbx_[0-9A-Za-z]+$

Header parameters

Idempotency-Keystring

Makes a retry safe. A retry with the same key and body gets the answer described for this operation; the same key with a different body gets 409 idempotency_mismatch. Keys are kept for 24 hours. The SDKs send a fresh key on every call they may retry.

min length 1 · max length 255

Request body

requiredmultipart/form-data

manifestWriteFilesManifestrequired

Which part holds which file. Paths live only here, never in part names, so any path survives every client's multipart encoding.

Show properties

filesobject[]required

min items 1

Show properties

Array of object

partstringrequired

The name of the form part that carries this file's bytes.

matches ^file_[0-9]+$

pathstringrequired

Where to write the file.

min length 1 · max length 4096 · matches ^\/

Responses

200

The files written.

filesWrittenFile[]required

Show properties

Array of WrittenFile

pathstringrequired

size_bytesintegerrequired

min 0

400

invalid_request: The request does not match the contract.

errorErrorDetailrequired

Show properties

codestringrequired

A stable, machine-readable code. Known codes: env_name_refused, file_not_found, file_too_large, idempotency_mismatch, image_not_built, in_progress, internal_error, invalid_request, lane_limit, name_in_use, not_found, payload_too_large, resources_over_cap, region_mismatch, sandbox_stopped, unavailable, store_prefix_refused, store_unavailable, unauthorized. New codes may be added, so treat an unknown one by its HTTP status.

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

401

unauthorized: The API key is missing, unknown or revoked.

errorErrorDetailrequired

Show properties

codestringrequired

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

404

not_found: No such resource in this key's lane. Another lane's ids are not found either.

errorErrorDetailrequired

Show properties

codestringrequired

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

409

sandbox_stopped: The sandbox has stopped: its lifetime or size limit was reached, or it was removed. in_progress: A call with this Idempotency-Key is still running, or the sandbox is still being created. Retry later. idempotency_mismatch: The Idempotency-Key was used before with a different body.

errorErrorDetailrequired

Show properties

codestringrequired

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

413

payload_too_large: The request body is larger than 32 MiB, all files together.

errorErrorDetailrequired

Show properties

codestringrequired

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

500

internal_error: The platform failed. A retry may succeed; for a call that creates or writes, retry with the same Idempotency-Key.

errorErrorDetailrequired

Show properties

codestringrequired

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

503

unavailable: A service behind the API could not be reached. Retry after a short wait; for a call that creates or writes, with the same Idempotency-Key.

errorErrorDetailrequired

Show properties

codestringrequired

messagestringrequired

A sentence for a person. Do not parse it.

request_idstringrequired

The same value as the X-Request-Id header.

Request

curl -X PUT 'https://api.ibby.ai/v1/sandboxes/sbx_7Hc2mQ/files' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  --form-string 'manifest={"files":[{"part":"file_0","path":"string"}]}' \
  --form-string 'property1=string' \
  --form-string 'property2=string'

const form = new FormData();
form.append("manifest", "{\"files\":[{\"part\":\"file_0\",\"path\":\"string\"}]}");
form.append("property1", "string");
form.append("property2", "string");

const response = await fetch("https://api.ibby.ai/v1/sandboxes/sbx_7Hc2mQ/files", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json"
  },
  body: form
});

import requests

response = requests.put(
    "https://api.ibby.ai/v1/sandboxes/sbx_7Hc2mQ/files",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json"
    },
    files=[
        ("manifest", (None, "{\"files\":[{\"part\":\"file_0\",\"path\":\"string\"}]}")),
        ("property1", (None, "string")),
        ("property2", (None, "string")),
    ],
)

Response

{
  "files": [
    {
      "path": "string",
      "size_bytes": 0
    }
  ]
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "sandbox_stopped",
    "message": "string",
    "request_id": "string"
  }
}