Skip to main content

Overview

The SolidGrids API is a RESTful API that enables users to upload an image, process it and retrieve the processed image from Amazon S3. The API consists of two main endpoints:

  • /api/upload - This endpoint is used to upload an image to Amazon S3. A signed URL for the uploaded image is returned in the response.
  • /api/pipe - This endpoint is used to retrieve the processed image. Authentication.

All API requests require an API token, which can be obtained from the SolidGrids Dasbboard.

Image Format​

The API supports image files in PNG and JPEG formats. The processed image will have the same content type as the original image.

Usage​

The API can be accessed via HTTP requests using the requests library in Python. The following steps outline the usage of the API:

  1. Make a POST request to the /api/upload endpoint to get a signed URL for the uploaded image.
  2. Upload the image to Amazon S3 using the signed URL.
  3. Make a POST request to the /api/process endpoint to get a signed URL for the processed image.
  4. Retrieve the processed image using the signed URL obtained in step 3.