Import StorageRedis

Create import storage

POST

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.

Request

This endpoint expects an object.
regex_filter
stringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urls
booleanOptional
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.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
path
stringOptional
Storage prefix (optional)
host
stringOptional
Server Host IP (optional)
port
stringOptional
Server Port (optional)
password
stringOptional
Server Password (optional)

Response

This endpoint returns an object
regex_filter
stringOptional
Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
use_blob_urls
booleanOptional
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.
title
stringOptional
Storage title
description
stringOptional
Storage description
project
integerOptional
Project ID
path
stringOptional
Storage prefix (optional)
host
stringOptional
Server Host IP (optional)
port
stringOptional
Server Port (optional)
password
stringOptional
Server Password (optional)
POST
1curl -X POST http://localhost:8080/api/storages/redis/ \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Successful
1{
2 "regex_filter": "regex_filter",
3 "use_blob_urls": true,
4 "title": "title",
5 "description": "description",
6 "project": 1,
7 "path": "path",
8 "host": "host",
9 "port": "port",
10 "password": "password"
11}