Write workspace files

curl --request POST \
  --url https://api.{domain}/v1/sessions/{session_id}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "type": "inline",
      "path": "data/input.csv",
      "data": "aWQsbmFtZQoxLGFjbWU="
    }
  ]
}
'

import requests

url = "https://api.{domain}/v1/sessions/{session_id}/files"

payload = { "files": [
        {
            "type": "inline",
            "path": "data/input.csv",
            "data": "aWQsbmFtZQoxLGFjbWU="
        }
    ] }
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({
    files: [{type: 'inline', path: 'data/input.csv', data: 'aWQsbmFtZQoxLGFjbWU='}]
  })
};

fetch('https://api.{domain}/v1/sessions/{session_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.{domain}/v1/sessions/{session_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([
    'files' => [
        [
                'type' => 'inline',
                'path' => 'data/input.csv',
                'data' => 'aWQsbmFtZQoxLGFjbWU='
        ]
    ]
  ]),
  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.{domain}/v1/sessions/{session_id}/files"

	payload := strings.NewReader("{\n  \"files\": [\n    {\n      \"type\": \"inline\",\n      \"path\": \"data/input.csv\",\n      \"data\": \"aWQsbmFtZQoxLGFjbWU=\"\n    }\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.{domain}/v1/sessions/{session_id}/files")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"files\": [\n    {\n      \"type\": \"inline\",\n      \"path\": \"data/input.csv\",\n      \"data\": \"aWQsbmFtZQoxLGFjbWU=\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{domain}/v1/sessions/{session_id}/files")

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  \"files\": [\n    {\n      \"type\": \"inline\",\n      \"path\": \"data/input.csv\",\n      \"data\": \"aWQsbmFtZQoxLGFjbWU=\"\n    }\n  ]\n}"

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

{
  "object": "list",
  "data": [
    {
      "object": "workspace_file",
      "path": "<string>",
      "size_bytes": 123
    }
  ]
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

POST

sessions

{session_id}

files

Write workspace files

curl --request POST \
  --url https://api.{domain}/v1/sessions/{session_id}/files \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "files": [
    {
      "type": "inline",
      "path": "data/input.csv",
      "data": "aWQsbmFtZQoxLGFjbWU="
    }
  ]
}
'

import requests

url = "https://api.{domain}/v1/sessions/{session_id}/files"

payload = { "files": [
        {
            "type": "inline",
            "path": "data/input.csv",
            "data": "aWQsbmFtZQoxLGFjbWU="
        }
    ] }
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({
    files: [{type: 'inline', path: 'data/input.csv', data: 'aWQsbmFtZQoxLGFjbWU='}]
  })
};

fetch('https://api.{domain}/v1/sessions/{session_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.{domain}/v1/sessions/{session_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([
    'files' => [
        [
                'type' => 'inline',
                'path' => 'data/input.csv',
                'data' => 'aWQsbmFtZQoxLGFjbWU='
        ]
    ]
  ]),
  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.{domain}/v1/sessions/{session_id}/files"

	payload := strings.NewReader("{\n  \"files\": [\n    {\n      \"type\": \"inline\",\n      \"path\": \"data/input.csv\",\n      \"data\": \"aWQsbmFtZQoxLGFjbWU=\"\n    }\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.{domain}/v1/sessions/{session_id}/files")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"files\": [\n    {\n      \"type\": \"inline\",\n      \"path\": \"data/input.csv\",\n      \"data\": \"aWQsbmFtZQoxLGFjbWU=\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.{domain}/v1/sessions/{session_id}/files")

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  \"files\": [\n    {\n      \"type\": \"inline\",\n      \"path\": \"data/input.csv\",\n      \"data\": \"aWQsbmFtZQoxLGFjbWU=\"\n    }\n  ]\n}"

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

{
  "object": "list",
  "data": [
    {
      "object": "workspace_file",
      "path": "<string>",
      "size_bytes": 123
    }
  ]
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

{
  "error": {
    "code": "invalid_request",
    "message": "<string>",
    "request_id": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A gbr_pat_ access token. Scopes are recorded on the token when it is minted.

Headers

Idempotency-Key

string

Retrying with the same key replays the first answer instead of acting again.

Maximum string length: 255

Body

application/json

files

object[]

required

Files to write into the running workspace. Same shape as environment.files, which seeds one before the first turn.

Show child attributes

Response

Write files into a running session's workspace.

What was written into the workspace. A path that was already there has been overwritten — that is what the request asked for.

object

string

required

Always list. Names the shape, so a value can be identified without knowing which call returned it.

Allowed value: "list"

data

object[]

required

Show child attributes

Start here

Running a session

Guides

Client libraries

When things go wrong

API reference

About this API

Endpoints

Write workspace files

Authorizations

Headers

Body

Response