Skip to main content
Return the project files with upload status, size, and download links.

Signature

Method signature on client.files:

Parameters

string
required
Project ID with prefix pp..

Returns

Promise<ProjectFile[]> Files stored in this project. Returns an array. Each item has these fields:
ProjectFileId
required
ID of the project file, with prefix ppf..
ProjectId
required
Project ID with prefix pp..
string
required
Name of the project file.
"pending" | "uploaded" | "failed"
required
File state: pending before finalization, uploaded after successful finalization, or failed if the upload failed.
number
required
Declared maximum size of the file, in bytes.
number | null
required
Finalized file size in bytes, or null before successful finalization.
string
required
Time the file upload was started, as an ISO 8601 timestamp.
string | null
required
Time the upload was finalized, as an ISO 8601 timestamp, or null before successful finalization.
string
required
The file download endpoint. API keys and signed-in users receive a 302 redirect to the download link. Project-scoped tokens receive JSON with a url field.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses: HTTP endpoint: GET /projects/{projectId}/files.