API Reference

Get Storage types

List Storage Types

get

Retrieves a list of storage types supported by Claid.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

To work with the Claid API, send requests over HTTPS and authenticate using the Authorization header in the following format:Authorization: Bearer <YOUR_API_KEY>. You do not need to provide a password.

To get your API key, sign in to your Claid account and click Create API key button from the Overview or API keys pages.

Claid API’s base URL is https://api.claid.ai/v1/. All available endpoints are listed in the Storage and Image sections.

Bearer

This API uses OAuth 2.0 bearer token (API key) to authorize requests.

Token URL:

Responses

200

List of storage types.

application/json

Wrapper for responses

401

Authorization is required.

application/json

403

Not enough permissions.

application/json

get

/v1/storage/storage-types

HTTPcURLJavaScriptPython

GET /v1/storage/storage-types HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Request

HTTP

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

cURL

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

To work with the Claid API, send requests over HTTPS and authenticate using the Authorization header in the following format:Authorization: Bearer <YOUR_API_KEY>. You do not need to provide a password.

To get your API key, sign in to your Claid account and click Create API key button from the Overview or API keys pages.

Claid API’s base URL is https://api.claid.ai/v1/. All available endpoints are listed in the Storage and Image sections.

Bearer

This API uses OAuth 2.0 bearer token (API key) to authorize requests.

Token URL:

Responses

200

Successful Response

application/json

Wrapper for responses

401

Authorization is required.

application/json

403

Not enough permissions.

application/json

get

/v1/storage/storages

HTTPcURLJavaScriptPython

GET /v1/storage/storages HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": [
    {
      "id": 1,
      "name": "text",
      "type": "web_folder",
      "parameters": {
        "path": "",
        "bucket": "text"
      },
      "created_at": "2026-03-09T12:56:28.634Z"
    }
  ]
}

Request

HTTP

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

cURL

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

To work with the Claid API, send requests over HTTPS and authenticate using the Authorization header in the following format:Authorization: Bearer <YOUR_API_KEY>. You do not need to provide a password.

To get your API key, sign in to your Claid account and click Create API key button from the Overview or API keys pages.

Claid API’s base URL is https://api.claid.ai/v1/. All available endpoints are listed in the Storage and Image sections.

Bearer

This API uses OAuth 2.0 bearer token (API key) to authorize requests.

Token URL:

Body

application/json

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.

Possible values:

parametersany ofRequired

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

or

or

Responses

200

Successful Response

application/json

Wrapper for responses

401

Authorization is required.

application/json

403

Not enough permissions.

application/json

422

Unprocessable Entity.

application/json

post

/v1/storage/storages

HTTPcURLJavaScriptPython

POST /v1/storage/storages HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 139

{
  "name": "text",
  "type": "web_folder",
  "parameters": {
    "path": "",
    "bucket": "text",
    "credentials": {
      "access_key": "text",
      "secret_access_key": "text"
    }
  }
}

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "",
      "bucket": "text",
      "credentials": {
        "access_key": "text"
      }
    },
    "created_at": "2026-03-09T12:56:28.634Z"
  }
}

Here is an example of creating AWS storage via API:

Request

HTTP

POST /v1/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

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.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

To work with the Claid API, send requests over HTTPS and authenticate using the Authorization header in the following format:Authorization: Bearer <YOUR_API_KEY>. You do not need to provide a password.

To get your API key, sign in to your Claid account and click Create API key button from the Overview or API keys pages.

Claid API’s base URL is https://api.claid.ai/v1/. All available endpoints are listed in the Storage and Image sections.

Bearer

This API uses OAuth 2.0 bearer token (API key) to authorize requests.

Token URL:

Path parameters

storage_idintegerRequired

Responses

200

Successful Response

application/json

Wrapper for responses

401

Authorization is required.

application/json

403

Not enough permissions.

application/json

404

Storage not found.

application/json

422

Unprocessable Entity.

application/json

get

/v1/storage/storages/{storage_id}

HTTPcURLJavaScriptPython

GET /v1/storage/storages/{storage_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "",
      "bucket": "text",
      "credentials": {
        "access_key": "text"
      }
    },
    "created_at": "2026-03-09T12:56:28.634Z"
  }
}

Request

HTTP

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

cURL

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 by id

Delete Storage

delete

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

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

To work with the Claid API, send requests over HTTPS and authenticate using the Authorization header in the following format:Authorization: Bearer <YOUR_API_KEY>. You do not need to provide a password.

To get your API key, sign in to your Claid account and click Create API key button from the Overview or API keys pages.

Claid API’s base URL is https://api.claid.ai/v1/. All available endpoints are listed in the Storage and Image sections.

Bearer

This API uses OAuth 2.0 bearer token (API key) to authorize requests.

Token URL:

Path parameters

storage_idintegerRequired

Responses

200

Successful Response

application/json

Wrapper for responses

dataanyOptional

401

Authorization is required.

application/json

403

Not enough permissions.

application/json

404

Storage not found.

application/json

422

Unprocessable Entity.

application/json

delete

/v1/storage/storages/{storage_id}

HTTPcURLJavaScriptPython

DELETE /v1/storage/storages/{storage_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "data": null
}

Request

HTTP

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

cURL

Update storage by id

Patch Storage

patch

Changes storage name, type, and/or parameters.

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2PasswordBearer

OAuth2passwordRequired

To work with the Claid API, send requests over HTTPS and authenticate using the Authorization header in the following format:Authorization: Bearer <YOUR_API_KEY>. You do not need to provide a password.

To get your API key, sign in to your Claid account and click Create API key button from the Overview or API keys pages.

Claid API’s base URL is https://api.claid.ai/v1/. All available endpoints are listed in the Storage and Image sections.

Bearer

This API uses OAuth 2.0 bearer token (API key) to authorize requests.

Token URL:

Path parameters

storage_idintegerRequired

Body

application/json

namestring · max: 50Optional

typestring · enumOptional

An enumeration.

Possible values:

parametersany ofOptional

or

or

Responses

200

Successful Response

application/json

Wrapper for responses

401

Authorization is required.

application/json

403

Not enough permissions.

application/json

404

Storage not found.

application/json

422

Unprocessable Entity.

application/json

patch

/v1/storage/storages/{storage_id}

HTTPcURLJavaScriptPython

PATCH /v1/storage/storages/{storage_id} HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 143

{
  "name": "text",
  "type": "web_folder",
  "parameters": {
    "path": "text",
    "bucket": "text",
    "credentials": {
      "access_key": "text",
      "secret_access_key": "text"
    }
  }
}

{
  "data": {
    "id": 1,
    "name": "text",
    "type": "web_folder",
    "parameters": {
      "path": "",
      "bucket": "text",
      "credentials": {
        "access_key": "text"
      }
    },
    "created_at": "2026-03-09T12:56:28.634Z"
  }
}

Request

HTTP

PATCH /v1/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

Response body

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