Skip to main content

API Reference

Endpoint: /upload​

Method​

POST

Headers​

  • Content-Type: application/json
  • Authorization: {{accessToken}}

Body​

{
  "contentType": "content_type",
  "name": "name"
}

Parameters​

  • contentType (string): The type of the content being uploaded (e.g., jpg, png, etc.).
  • name (string): The name of the file being uploaded.

Responses​

200 OK

The file has been uploaded successfully. The body of the response will contain the following information:

{
  "signedRequest": "signed_url",
  "key": "s3_key"
}
  • signedRequest (string): The signed URL that can be used to upload the file to S3.
  • key (string): The key for the file in the S3 bucket.

400 Bad Request

The request was invalid or could not be processed.

401 Unauthorized

The API token provided in the Authorization header is invalid.

Endpoint: /pipe​

Method​

POST

Headers​

  • Content-Type: application/json
  • Authorization: {{accessToken}}

Body​

{
  "key": "s3_key"
}

Parameters​

  • key (string): The key for the file in the S3 bucket.

Responses​

200 OK

The image has been processed successfully. The body of the response will contain the following information:

{
  "signedRequest": "signed_url"
}
  • signedRequest (string): The signed URL that can be used to retrieve the processed image from S3.

400 Bad Request

The request was invalid or could not be processed.

401 Unauthorized

The API token provided in the Authorization header is invalid.