Sign Up
Loading...

Create File Endpoints

Watch the walkthrough

Delete Files Endpoint Generation

Generate an endpoint for deleting files from the file store.

Recorded with an earlier Twidget interface. Names, control locations and available options may differ; use the linked documentation for current guidance.

Watch tutorial (1:53)

Browse all video tutorials

Overview

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.

Creating File Endpoints

To create a file endpoint in Twidget, follow these steps:

  1. Navigate to the API Page:

    • Go to the API page in your Twidget dashboard.
  2. Click 'Create Endpoint':

    • In the top right corner, click the 'Create Endpoint' button.
  1. Select 'Manage Files':

    • In the newly opened sidebar, select 'Manage Files'.
  1. Choose an Endpoint:

    • You'll be presented with a selection of seven endpoints to choose from. Each endpoint is designed for a specific file operation, as detailed below.

Available File Endpoints

Here are the endpoints you can generate along with their details:

  1. Upload a Single File to the File Store

    • Method: POST

    • Name: Upload a single file to the file store

    • Path: /single

  2. 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.

  3. Retrieve a Single File

    • Method: POST

    • Name: Retrieve a single file

    • Path: /file

  4. Retrieve List of Files

    • Method: POST

    • Name: Retrieve list of files

    • Path: /folder

  5. Retrieve Content of a File

    • Method: POST

    • Name: Retrieve content of a file

    • Path: /content

  6. Rename a File in the File Store

    • Method: PUT

    • Name: Rename a file in the file store

    • Path: /rename

  7. Delete Files from the File Store

    • Method: DELETE

    • Name: Delete files from the file store

  8. Update File Permissions

    • Method: PUT

    • Name: Update File Permissions

    • Path: /permissions

Customizing Endpoints

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.

Related Topics

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 Settings

The API settings in Twidget enable you to customize your APIs to fit your requirements. Here’s how you can do it: Configure. 1. Navigate to the API page. 2. Click on the Settings button located at the top-right corner. This will open a sidebar where you can configure various settings for your API. A...

Endpoint Basics

An endpoint refers to a specific URL (Uniform Resource Locator) that a client can access to interact with the API and perform various operations. Endpoints act as gateways that allow clients (such as web or mobile applications) to communicate with the server hosting the API and perform actions like ...

Customer authentication tools

Use your workspace's Authentication page to manage customer access and independent login sessions. Build signup, login and logout workflows with the authentication commands in the command picker. These tools use your existing [authentication table](/docs/database/authentication-table). They manage p...

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...