API ReferenceImport StorageRedis

Create import storage

Create a new source storage connection to a Redis database.

For information about the required fields and prerequisites, see Redis database in the Label Studio documentation.

After you add the storage, you should validate the connection before attempting to sync your data. Your data will not be imported until you sync your connection.

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

Request

This endpoint expects an object.
regex_filterstringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urlsbooleanOptionalDefaults to false
Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
titlestringOptional
Storage title
descriptionstringOptional
Storage description
projectintegerOptional
Project ID
pathstringOptional

Storage prefix (optional)

hoststringOptional

Server Host IP (optional)

portstringOptional

Server Port (optional)

passwordstringOptional

Server Password (optional)

Response

regex_filterstring or null
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urlsboolean or nullDefaults to false
Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
titlestring or null
Storage title
descriptionstring or null
Storage description
projectinteger or null
Project ID
pathstring or null

Storage prefix (optional)

hoststring or null

Server Host IP (optional)

portstring or null

Server Port (optional)

passwordstring or null

Server Password (optional)