Initiate file upload

Start a new file upload to Friendli Suite via the API. Returns a file ID and pre-signed upload URL to begin transferring your file data.

POST /beta/file

Initiate file upload

cURL

curl --request POST \
  --url https://api.friendli.ai/beta/file \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "size": 123,
  "digest": "<string>",
  "projectId": "<string>"
}
'

200

{
  "fileId": "<string>",
  "uploadUrl": "<string>",
  "aws": {}
}

Initiate file upload.

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).

Body

application/json

Initiate file upload request.

name · string · required

Name of the file.

size · integer · required

Size of the file in bytes.

digest · string · required

Digest of the file.

Pattern: ^[a-zA-Z0-9_+.-]+:[a-fA-F0-9]+$

projectId · string · required

ID of the project the file belongs to.

Response

200

application/json

OK - File is already uploaded.

Initiate file upload response.

fileId · string · required

ID of the file.

uploadUrl · string | null

Upload URL of the file. None if the file is already uploaded.

aws · Aws · object

AWS fields to be uploaded with file.