Twidget allows you to create file endpoints, which enable you to manage files in your file store. This feature is designed to streamline your workflow by providing predefined endpoints for common file operations.
To create a file endpoint in Twidget, follow these steps:
Navigate to the API Page:
Click 'Create Endpoint':
Select 'Manage Files':
Choose an Endpoint:
Here are the endpoints you can generate along with their details:
Upload a Single File to the File Store
Method: POST
Name: Upload a single file to the file store
Path: /single
-
Upload Multiple Files to the File Store
Method: POST
Name: Upload multiple files to the file store
Path: /multiple
Note: This endpoint is disabled for users on the 'FREE' plan.
-
Retrieve a Single File
Method: POST
Name: Retrieve a single file
Path: /file
-
Retrieve List of Files
Method: POST
Name: Retrieve list of files
Path: /folder
Retrieve Content of a File
Method: POST
Name: Retrieve content of a file
Path: /content
Rename a File in the File Store
Method: PUT
Name: Rename a file in the file store
Path: /rename
-
Delete Files from the File Store
Method: DELETE
Name: Delete files from the file store
-
Update File Permissions
Method: PUT
Name: Update File Permissions
Path: /permissions
-
Each of these endpoints can be customized to fit your specific requirements. This flexibility allows you to tailor the endpoint commands to meet the unique needs of your application, saving you significant time and effort.
Generate CRUD Endpoints
What are CRUD Endpoints?. CRUD stands for Create, Read, Update, Delete. These are the basic operations required to manage data in a database. Each operation corresponds to a specific HTTP method: - Create: Adds new data (HTTP POST) - Read: Retrieves data (HTTP GET) - Update: Modifies existing data (...
Response Settings
You can customise the successful response from an endpoint, including its status code and additional headers. Configure a response. 1. Open the endpoint and its Output editor. 2. Select RESPONSE. 3. Choose a status code or select a variable from the commands section. 4. Add a response-headers object...
Authentication
Twidget supports Bearer Authentication to ensure secure access to your endpoints. You can specify which endpoints should be secured or open. Once secured, an endpoint can only be accessed using a valid Bearer Token, which is generated via our API. Additionally, we provide functionality to generate a...
Streaming responses
Send updates progressively while an endpoint is running, instead of waiting for one final response. This is useful for progress messages or generated text that your app can display as it arrives. Enable a streaming endpoint. 1. Open the endpoint and choose Update endpoint. 2. Set Response mode to St...
API Limits
API limits help you control how often people can call the endpoints in a workspace. You can set a short-term limit and a monthly allowance. Set workspace limits. 1. Select the workspace you want to manage. 2. Open Settings, then API Limits. 3. Enable API limits. 4. Under Allowance per, choose user o...
