Skip to content
v1.0.0
OAS 3.0.1

Stripo Plugin Storage API

It is required to support the set of the methods described below to provide successful communication between the two systems: the Stripo server and yours. The Basic Authentication is used to send these requests. Note, that your storage must support chunked-encoding mode if you want to get logs about any request. See more here.

Server:
Client Libraries

Methods

Get list of files

Allows you to retrieve a list of files within specified folders. This method helps you manage and access your file directory efficiently by providing a comprehensive list of available files in the targeted folders, streamlining your workflow and file management within the Stripo platform.

Query Parameters
  • keys
    Type: string
    required

    Comma-separated list of folder keys.

Responses
  • 200
    Type: array Folder[]

    A list of documents grouped by folder keys.

    • documents
      Type: array Document[]
    • key
      Type: string

      Generated key for the folder.

Request Example for get/
curl '/?keys='
[
  {
    "key": "string",
    "documents": [
      {
        "url": "string",
        "originalName": "string",
        "uploadTime": 1,
        "size": 1,
        "height": 1,
        "width": 1,
        "thumbnailUrl": "string"
      }
    ]
  }
]

Upload file to storage

Enables you to upload an image to a specified folder in your storage. This method facilitates the organization and management of your images by allowing you to easily add new files to designated locations within your Stripo storage, ensuring your media assets are well-organized and readily accessible.

Body
multipart/form-data
  • file
    Type: string

    Multipart file to be uploaded.

  • key
    Type: string

    Folder key where the file will be uploaded.

Responses
  • 200
    Type: object
    • height
      Type: integer

      Document height in pixels (px).

    • original​Name
      Type: string

      Document name.

    • size
      Type: integer

      Document size in bytes.

    • thumbnail​Url
      Type: string

      Absolute URL of document preview thumbnail.

    • upload​Time
      Type: integer

      Document upload time in milliseconds.

    • url
      Type: string

      Absolute URL to the document.

    • width
      Type: integer

      Document width in pixels (px).

Request Example for post/
curl / \
  --request POST \
  --header 'Content-Type: multipart/form-data' \
  --form 'key=' \
  --form 'file='
{
  "url": "string",
  "originalName": "string",
  "uploadTime": 1,
  "size": 1,
  "height": 1,
  "width": 1,
  "thumbnailUrl": "string"
}

Remove file from storage

Marks a file as removed, so it is no longer displayed within the folder for the customer. Physically, the file is not deleted from storage, ensuring data integrity and the possibility of recovery if needed. This method helps maintain an organized and clutter-free storage view for users.

Body
application/json
  • url
    Type: string

    Absolute URL to the document.

Responses
  • 200
    Type: object
    • message
      Type: string
Request Example for post/delete
curl /delete \
  --request POST \
  --header 'Content-Type: application/json' \
  --data '{
  "url": ""
}'
{
  "message": "string"
}

Get file info

Allows you to retrieve detailed information about a specific file. This information helps your customers see useful details in the editor once the image is selected on the UI, enhancing their file management and editing experience within the Stripo platform.

Query Parameters
  • src
    Type: string
    required

    Absolute URL of the document.

Responses
  • 200
    Type: object
    • original​Name
      Type: string

      Document original name.

    • size
      Type: integer

      Document size in bytes.

Request Example for get/info
curl '/info?src='
{
  "originalName": "string",
  "size": 1
}

Models