Documentation | Files

Files

FilesResource

Methods

client.files.create() ->

SGPFile

post/v5/files

Upload File

client.files.import_from_cloud() ->

FileImportFromCloudResponse

post/v5/files/cloud_imports

Import files from existing blob storage in cloud (batch operation)

client.files.list() -> SyncCursorPage[

SGPFile

]

get/v5/files

List Files

Parameters

account_id: Optional[str]

Optional search by account_id

ending_before: Optional[str]

filename: Optional[str]

Filter files by filename (case-insensitive partial match)

limit: Optional[int]

(maximum: 10000, minimum: 1, default: 100)

sort_by: Optional[str]

sort_order: Optional[

SortOrder

]

starting_after: Optional[str]

Returns

SGPFile

id: str

created_at:

datetime

(format: date-time)

created_by:

Identity

The identity that created the entity.

filename: str

md5_checksum: str

mime_type: str

size: int

duration_seconds: Optional[int]

object: Optional[Literal["file"]]

(default: "file")

tags: Optional[Dict[str,

object

]]

Request example

import os
from scale_gp_beta import SGPClient

client = SGPClient(
    api_key=os.environ.get("SGP_API_KEY"),  # This is the default and can be omitted
)
page = client.files.list()
page = page.items[0]
print(page.id)

200Example

{
  "has_more": true,
  "items": [
    {
      "id": "id",
      "created_at": "2019-12-27T18:11:19.117Z",
      "created_by": {
        "id": "id",
        "type": "user",
        "object": "identity"
      },
      "filename": "filename",
      "md5_checksum": "md5_checksum",
      "mime_type": "mime_type",
      "size": 0,
      "duration_seconds": 0,
      "object": "file",
      "tags": {
        "foo": "bar"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}