Skip to main content
GET
/
api
/
sandboxes
/
file
cURL
curl --request GET \
  --url https://recoup-api.vercel.app/api/sandboxes/file \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "content": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

Query Parameters

​
path
string
required

The file path within the repository (e.g. "src/index.ts" or "README.md").

Example:

"src/index.ts"

Response

File contents retrieved successfully

​
status
enum<string>
required

Status of the operation

Available options:
success
​
content
string
required

The raw text content of the file