Skip to main content
GET
/
api
/
v1
/
files
/
preview
Preview file
curl --request GET \
  --url http://localhost:3000/api/v1/files/preview \
  --header 'Authorization: Bearer <token>'
{
  "ok": true,
  "data": null
}

Authorizations

​
Authorization
string
header
required

API key passed as a Bearer token. Configure via the apiKeys field in polpo.json or the POLPO_API_KEY environment variable.

Query Parameters

​
path
string
required

Absolute or relative file path

Example:

".polpo/output/task-123/report.md"

​
maxLines
string

Maximum lines to return for text files (default: 500)

Response

File preview data

​
ok
boolean
required
​
data
unknown