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

# 读取文件

GET https://sandbox.xapi.to/v1/sandboxes/{id}/files

读取运行中实例内的 UTF-8 文本或 base64 编码二进制内容。路径必须属于实例工作区。

Reference: https://docs.xapi.to/sandbox/api-reference/execution/read-file

## Authentication

- `XAPI-Key` header (required) — 在 xAPI Console 创建的 API Key。只会发送给 *.xapi.to。

## Servers

- `https://sandbox.xapi.to` (Production, default)
- `https://sandbox.test.xapi.to` (Test)

## Request

### Path parameters

- `id` (string, required) — xAPI Sandbox 实例 UUID。

### Query parameters

- `path` (string, required) — 相对于 Sandbox 工作区的文件路径；不能包含 `..` 或其他父目录跳转片段。
- `encoding` (enum, optional, default: utf8) — 返回内容的编码。文本使用 utf8；二进制文件使用 base64，content 不包含 data URI 前缀。
  - Allowed values: `utf8`, `base64`

## Response

### 200

文件内容

- `path` (string, required) — 实际读取的工作区路径。
- `content` (string, required) — 文件内容；encoding=utf8 时为文本，encoding=base64 时为无 data URI 前缀的 Base64。
- `encoding` (enum, required) — content 当前使用的编码。
  - Allowed values: `utf8`, `base64`

## Errors

### 404 Not Found Error

实例或资源不存在，或者不属于当前账户

- `statusCode` (integer, optional) — HTTP 状态码的数值形式，例如 400、401、402、404、409 或 429。
- `message` (ErrorMessage, optional) — 面向调用方的错误原因；校验失败时可能是多条消息数组。
- `error` (string, optional) — HTTP 错误类别，例如 Bad Request、Unauthorized 或 Conflict。

## Types

### ErrorMessage

面向调用方的错误原因；校验失败时可能是多条消息数组。

- string
- list of string

## Examples

**Response**

```json
{
  "path": "result.txt",
  "content": "XAPI_SANDBOX_OK=42",
  "encoding": "utf8"
}
```

**SDK Code**

```python
import requests

url = "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files"

querystring = {"encoding":"utf8","path":"result.txt"}

headers = {"XAPI-Key": "<apiKey>"}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript
const url = 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt';
const options = {method: 'GET', headers: {'XAPI-Key': '<apiKey>'}};

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

```go
package main

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

func main() {

	url := "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("XAPI-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

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

url = URI("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["XAPI-Key"] = '<apiKey>'

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

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

HttpResponse<String> response = Unirest.get("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt")
  .header("XAPI-Key", "<apiKey>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt', [
  'headers' => [
    'XAPI-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt");
var request = new RestRequest(Method.GET);
request.AddHeader("XAPI-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["XAPI-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox.xapi.to/v1/sandboxes/33333333-3333-4333-8333-333333333333/files?encoding=utf8&path=result.txt")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

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()
```