API Reference

Get Storage types

List Storage Types

get

Retrieves a list of storage types supported by Claid.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1-beta1/storage/storage-types'

200

401

403

{
  "data": [
    "web_folder",
    "s3",
    "gcs"
  ]
}

List of storage types.

Request

GET /v1-beta1/storage/storage-types HTTP/1.1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}

curl -X GET --location "https://api.claid.ai/v1-beta1/storage/storage-types" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}"

Response body

{
  "data": [
    "web_folder",
    "s3",
    "gcs"
  ]
}

Get Connected Storages

List Storages

get

Retrieves a list of storages connected to your Claid account, as well as their id, name, type, and parameters.

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1-beta1/storage/storages'

200

401

403

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "type": "web_folder",
      "parameters": {
        "path": "text",
        "bucket": "text"
      },
      "created_at": "2025-03-24T04:15:57.541Z"
    }
  ]
}

Successful Response

Request

GET /v1-beta1/storage/storages HTTP/1.1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}

curl -X GET --location "https://api.claid.ai/v1-beta1/storage/storages" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}"

Response body

{
  "data": [
    {
      "id": 1,
      "name": "s3-playground",
      "type": "s3",
      "parameters": {
        "path": "/input/",
        "bucket": "playground"
      },
      "created_at": "2022-01-10T18:27:16.362118+00:00"
    },
    {
      "id": 2,
      "name": "designer-uploads",
      "type": "gcs",
      "parameters": {
        "path": "",
        "bucket": "image-uploads"
      },
      "created_at": "2022-01-10T18:28:22.100041+00:00"
    }
  ]
}

Create a new Claid Storage

Create Storage

post

Connects storage to Claid. You can connect your AWS S3 or GCP bucket, or your own web folder.

Authorizations

Body

namestring · max: 50required

The name of storage in Claid. Note: it doesn't have to be the same as a global name of a bucket.

typestring · enumrequired

An enumeration.

Options: web_folder, s3, gcs

parametersany ofrequired

Global parameters of storage (as opposed to Claid's internal properties, such as name and type)

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/v1-beta1/storage/storages' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "text",
      "bucket": "text",
      "credentials": {
        "access_key": "text",
        "secret_access_key": "text"
      }
    }
  }'

200

401

403

422

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "text",
      "bucket": "text",
      "credentials": {
        "access_key": "text"
      }
    },
    "created_at": "2025-03-24T04:15:57.541Z"
  }
}

Successful Response

Here is an example of creating AWS storage via API:

Request

POST /v1-beta1/storage/storages
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}
Content-Type: application/json

{
  "name": "s3-playground",
  "type": "s3",
  "parameters": {
    "bucket": "playground",
    "credentials": {
      "access_key": "AKIAXXXXXXX",
      "secret_access_key": "YourSecretAccessKey"
    }
  }
}

curl -X POST --location "https://api.claid.ai/v1-beta1/storage/storages" \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}" \
    -H "Content-Type: application/json" \
    -d "{
          \"name\": \"s3-playground\",
          \"type\": \"s3\",
          \"parameters\": {
            \"bucket\": \"playground\",
            \"credentials\": {
              \"access_key\": \"AKIAXXXXXXX\",
              \"secret_access_key\": \"YourSecretAccessKey\"
            }
          }
        }"

Response body

{
  "data": {
    "id": 1,
    "name": "s3-playground",
    "type": "s3",
    "parameters": {
      "path": "",
      "bucket": "playground"
    },
    "created_at": "2022-05-10T10:29:12.754824+00:00"
  }
}

parameters supported by the AWS S3 storage:

Parameter

Type

name

string

bucket

string

prefix

string

credentials.access_key

string

credentials.secret_access_key

string

parameters supported by the GCS storage: #todo

name

string

bucket

string

prefix

string

credentials.access_key

string

credentials.secret_access_key

string

parameters supported by the Web Folder storage:

name

string

base_url

string

Describe storage by id

Get Storage

get

Retrieves information about particular storage, including its id, name, type, and parameters.

Authorizations

Path parameters

storage_idintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/v1-beta1/storage/storages/{storage_id}'

200

401

403

404

422

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "text",
      "bucket": "text",
      "credentials": {
        "access_key": "text"
      }
    },
    "created_at": "2025-03-24T04:15:57.541Z"
  }
}

Successful Response

Request

GET /v1-beta1/storage/storages/1 HTTP/1.1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}

curl -X GET --location "https://api.claid.ai/v1-beta1/storage/storages/1" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}"

Response body

{
  "data": {
    "id": 1,
    "name": "s3-playground",
    "type": "s3",
    "parameters": {
      "path": "",
      "bucket": "playground"
    },
    "created_at": "2022-05-10T10:29:12.754824+00:00"
  }
}

Delete Storage

delete

Disconnects storage from Claid. Note: It doesn't delete your bucket on your cloud platform.

Authorizations

Path parameters

storage_idintegerrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/v1-beta1/storage/storages/{storage_id}'

200

401

403

404

422

{
  "data": null
}

Successful Response

Request

DELETE /v1-beta1/storage/storages/1 HTTP/1.1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}

curl -X DELETE --location "https://api.claid.ai/v1-beta1/storage/storages/1" --http1.1 \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}"

Patch Storage

patch

Changes storage name, type, and/or parameters.

Authorizations

Path parameters

storage_idintegerrequired

Body

namestring · max: 50optional

typestring · enumoptional

An enumeration.

Options: web_folder, s3, gcs

parametersany ofoptional

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url '/v1-beta1/storage/storages/{storage_id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "text",
      "bucket": "text",
      "credentials": {
        "access_key": "text",
        "secret_access_key": "text"
      }
    }
  }'

200

401

403

404

422

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "text",
      "bucket": "text",
      "credentials": {
        "access_key": "text"
      }
    },
    "created_at": "2025-03-24T04:15:57.541Z"
  }
}

Successful Response

Request

PATCH /v1-beta1/storage/storages/1
Host: api.claid.ai
Authorization: Bearer {YOUR_API_KEY}
Content-Type: application/json

{
  "name": "s3-playground",
  "type": "s3",
  "parameters": {
    "bucket": "playground",
    "credentials": {
      "access_key": "AKIAXXXXXXX",
      "secret_access_key": "YourSecretAccessKey"
    }
  }
}

curl -X PATCH --location "https://api.claid.ai/v1-beta1/storage/storages/1" \
    -H "Host: api.claid.ai" \
    -H "Authorization: Bearer {YOUR_API_KEY}" \
    -H "Content-Type: application/json" \
    -d "{
          \"name\": \"s3-playground\",
          \"type\": \"s3\",
          \"parameters\": {
            \"bucket\": \"playground\",
            \"credentials\": {
              \"access_key\": \"AKIAXXXXXXX\",
              \"secret_access_key\": \"YourSecretAccessKey\"
            }
          }
        }"

Response body

{
  "data": {
    "id": 1,
    "name": "s3-playground",
    "type": "s3",
    "parameters": {
      "path": "",
      "bucket": "playground"
    },
    "created_at": "2022-05-10T10:29:12.754824+00:00"
  }
}

PreviousWeb Folder NextE-commerce

Last updated 10 months ago

Get Storage types

List Storage Types

Response body

Get Connected Storages

List Storages

Response body

Create a new Claid Storage

Create Storage

Show S3 parameters

Show GCS parameters

Show web folder parameters

Response body

Describe storage by id

Get Storage

Response body

Delete Storage

Patch Storage

Show S3ParametersUpdate_Pydantic

Show GCSParametersUpdate_Pydantic

Show web folder parameters

Response body