Documentation | Files

API Reference

Files

FilesResource

Methods

client.files.create() ->

File

post/v5/files

Upload File

client.files.delete() ->

FileDeleteResponse

delete/v5/files/{file_id}

Delete File

client.files.list() -> SyncCursorPage[

File

]

get/v5/files

List Files

client.files.retrieve() ->

File

get/v5/files/{file_id}

Get File

Parameters

file_id: str

Returns

File

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

object: Optional[Literal["file"]]

(default: "file")

tags: Optional[Dict[str,

object

]]

Request example

from scale_gp_beta import SGPClient

client = SGPClient(
    api_key="My API Key",
)
file = client.files.retrieve(
    "file_id",
)
print(file.id)

200Example

{
  "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,
  "object": "file",
  "tags": {
    "foo": "bar"
  }
}

client.files.update(, ) ->

File

patch/v5/files/{file_id}

Update File

Domain types

class File: ...

class FileList: ...

Files

Content

FilesResource.ContentResource

Methods

client.files.content.retrieve() ->

object

get/v5/files/{file_id}/content

Get File Content