mirror of
https://github.com/LukeHagar/comfy-deploy-python.git
synced 2025-12-06 04:19:25 +00:00
init
This commit is contained in:
47
docs/sdks/files/README.md
Normal file
47
docs/sdks/files/README.md
Normal file
@@ -0,0 +1,47 @@
|
||||
# Files
|
||||
(*files*)
|
||||
|
||||
### Available Operations
|
||||
|
||||
* [get_upload_url](#get_upload_url) - Upload any files to the storage
|
||||
|
||||
## get_upload_url
|
||||
|
||||
Usually when you run something, you want to upload a file, image etc.
|
||||
|
||||
### Example Usage
|
||||
|
||||
```python
|
||||
import comfydeploy
|
||||
from comfydeploy.models import operations
|
||||
|
||||
s = comfydeploy.ComfyDeploy(
|
||||
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.files.get_upload_url(type=operations.Type.APPLICATION_OCTET_STREAM, file_size='<value>')
|
||||
|
||||
if res.object is not None:
|
||||
# handle response
|
||||
pass
|
||||
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
| Parameter | Type | Required | Description |
|
||||
| -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- | -------------------------------------------------- |
|
||||
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_check_mark: | N/A |
|
||||
| `file_size` | *str* | :heavy_check_mark: | N/A |
|
||||
|
||||
|
||||
### Response
|
||||
|
||||
**[operations.GetUploadURLResponse](../../models/operations/getuploadurlresponse.md)**
|
||||
### Errors
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| ------------------------------- | ------------------------------- | ------------------------------- |
|
||||
| errors.GetUploadURLResponseBody | 500 | application/json |
|
||||
| errors.SDKError | 4xx-5xx | */* |
|
||||
Reference in New Issue
Block a user