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

Parameters

ending_before: Optional[str]

limit: Optional[int]

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

sort_order: Optional[Literal["asc", "desc"]]

(default: "asc")

"asc"

"desc"

starting_after: Optional[str]

Returns

File

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_user_id": "created_by_user_id",
      "filename": "filename",
      "md5_checksum": "md5_checksum",
      "mime_type": "mime_type",
      "size": 0,
      "object": "file",
      "tags": {
        "foo": "bar"
      }
    }
  ],
  "total": 0,
  "limit": 0,
  "object": "list"
}

client.files.retrieve() ->

File

get/v5/files/{file_id}

Get File

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