{
  "opencollection": "1.0.0",
  "info": {
    "name": "deepset Cloud API (deepset AI Platform) Files API",
    "version": "1.0"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Files",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List files",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/files",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "limit",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "List files"
        },
        {
          "info": {
            "name": "Upload a file",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/files",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "write_mode",
                "value": "",
                "type": "query",
                "description": "How to handle a file that already exists, e.g. OVERWRITE."
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Upload a file"
        },
        {
          "info": {
            "name": "Delete a file",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/files/:file_id",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Delete a file"
        },
        {
          "info": {
            "name": "Update file metadata",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/files/:file_id/meta",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "file_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update file metadata"
        },
        {
          "info": {
            "name": "Create an upload session",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/upload_sessions",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Opens a session for chunked uploads of many files."
        },
        {
          "info": {
            "name": "Get upload session details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/upload_sessions/:session_id",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get upload session details"
        },
        {
          "info": {
            "name": "Close an upload session",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.cloud.deepset.ai/api/v1/workspaces/:workspace_name/upload_sessions/:session_id",
            "params": [
              {
                "name": "workspace_name",
                "value": "",
                "type": "path"
              },
              {
                "name": "session_id",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Close an upload session"
        }
      ]
    }
  ],
  "bundled": true
}