30 atoms
Base tier

About

This API lets you to convert jpeg or jpg images to webp format.
WebP outperforms JPEG with its enhanced compression, achieving up to 30% smaller file sizes while maintaining similar image quality. This leads to reduced bandwidth consumption and faster web page loading. Unlike JPEG, WebP provides lossless compression and transparency support, offering greater flexibility. By balancing visual quality and performance, WebP serves as an ideal solution for optimizing web content and improving user experience, making it a preferred choice over traditional formats like JPEG.
A successful request returns the webp image in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.
Endpoint Selector
Input
Output

API Playground

Documentation

input file: output file
POST
https://api.apyhub.com/convert/image/jpeg/webp/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/convert/image/jpeg/webp/file?output=test-sample' \
2
--header 'apy-token: {{token}}' \
3
--form 'image=@"stock-photo.jpg"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe output file name for the webp image.
Request Body
AttributeTypeMandatoryDescription
imageFileYesThe source image file in jpeg or jpg format.
Sample Response
The method returns the webp image in the output file mentioned in the URI.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the image file is corrupt.
500If any unexpected error occurs while processing the request.

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.