Get file info

Retrieve metadata for a file stored in Friendli Suite by file ID via the API. Returns filename, size, upload status, and creation timestamp.

GET /beta/file/{file_id}

Get file info

cURL

curl --request GET \
  --url https://api.friendli.ai/beta/file/{file_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "file-id",
  "name": "file-name",
  "size": 1024,
  "digest": "file-digest",
  "project_id": "project-id",
  "creator_id": "creator-id",
  "created_at": 1705244400,
  "expires_at": 1765724399,
  "status": "UPLOADED"
}

Get file info.

To request successfully, it is required to enter a Personal API Key (e.g. flp_XXX) in the Bearer Token field. Refer to the authentication section on our introduction page to learn more and visit here to generate your API Key.

This API is currently in Beta. While we strive to provide a stable and reliable experience, this feature is still under active development. As a result, you may encounter unexpected behavior or limitations. We encourage you to provide feedback to help us improve the feature before its official release.

• Feature request & feedback
• Contact support

Authorizations

Authorization · string · header · required

When using Friendli Suite API for inference requests, you need to provide a Friendli Token for authentication and authorization purposes.

For more detailed information, please refer here.

Headers

X-Friendli-Team · string | null

ID of team to run requests as (optional parameter).

Path Parameters

file_id · string · required

File ID

Response

200

application/json

OK

File information.

id · string · required

ID of the file.

name · string · required

Name of the file.

size · integer · required

Size of the file in bytes.

digest · string · required

SHA256 hash of the file.

projectId · string · required

ID of the project the file belongs to.

creatorId · string · required

ID of the creator of the file.

createdAt · string<date-time> · required

Unix timestamp (in seconds) of when the file was created.

expiresAt · string<date-time> | null · required

Unix timestamp (in seconds) of when the file will expire.

status · enum<string> · required

Status of the file upload.

Available options: UPLOADING, UPLOADED, FAILED, DELETED