You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "## Image optimization endpoint\n\n**Endpoint:** \n`GET /source/v1/files/image/:filename`\n\n**Description:** \nThis endpoint allows you to retrieve and optimize an image file stored on the server by specifying the filename as a URL parameter. You can apply various optimization options through query parameters.\n\n### URL Parameters\n\n| Key | Type | Description |\n| --- | --- | --- |\n| filename | String | The name of the image file to retrieve and optimize |\n\n### Query Parameters\n\n| Key | Type | Description |\n| --- | --- | --- |\n| fm | String | (Optional) Format (e.g., jpg, png, webp) |\n| q | Number | (Optional) Quality (e.g., 80) |\n| w | Number | (Optional) Width (e.g., 300) |\n| h | Number | (Optional) Height (e.g., 300) |\n| fit | String | (Optional) Fit mode (e.g., cover, contain) |\n\n### Example Request in Postman\n\n1. Set the request method to **GET**.\n \n2. Set the URL to: `{{url}}/source/v1/files/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover`\n \n3. (Optional) Add any required headers.\n \n4. Click **Send** to retrieve and optimize the image.\n \n\n### Example cURL\n\n``` sh\ncurl -X GET \"{{url}}/source/v1/files/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover\"\n\n ```\n\n### Example Response\n\nThe response will be the optimized image file. The content type will depend on the requested format (e.g., `image/webp` for WebP format).\n\n``` http\nHTTP/1.1 200 OK\nContent-Type: image/webp\nContent-Length: 12345\n(binary image data)\n\n ```"
457
+
"description": "## Image optimization endpoint\n\n**Endpoint:** \n`GET /assets/image/:filename`\n\n**Description:** \nThis endpoint allows you to retrieve and optimize an image file stored on the server by specifying the filename as a URL parameter. You can apply various optimization options through query parameters.\n\n### URL Parameters\n\n| Key | Type | Description |\n| --- | --- | --- |\n| filename | String | The name of the image file to retrieve and optimize |\n\n### Query Parameters\n\n| Key | Type | Description |\n| --- | --- | --- |\n| fm | String | (Optional) Format (e.g., jpg, png, webp) |\n| q | Number | (Optional) Quality (e.g., 80) |\n| w | Number | (Optional) Width (e.g., 300) |\n| h | Number | (Optional) Height (e.g., 300) |\n| fit | String | (Optional) Fit mode (e.g., cover, contain) |\n\n### Example Request in Postman\n\n1. Set the request method to **GET**.\n \n2. Set the URL to: `{{url}}/assets/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover`\n \n3. (Optional) Add any required headers.\n \n4. Click **Send** to retrieve and optimize the image.\n \n\n### Example cURL\n\n``` sh\ncurl -X GET \"{{url}}/assets/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover\"\n\n ```\n\n### Example Response\n\nThe response will be the optimized image file. The content type will depend on the requested format (e.g., `image/webp` for WebP format).\n\n``` http\nHTTP/1.1 200 OK\nContent-Type: image/webp\nContent-Length: 12345\n(binary image data)\n\n ```"
Copy file name to clipboardExpand all lines: docs/how-to-use/get-image-endpoint.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Image optimization endpoint
2
2
**Endpoint:**
3
-
`GET /source/v1/files/image/:filename`
3
+
`GET /assets/image/:filename`
4
4
5
5
**Description:**
6
6
This endpoint allows you to retrieve and optimize an image file stored on the server by specifying the filename as a URL parameter. You can apply various optimization options through query parameters.
@@ -21,13 +21,13 @@ This endpoint allows you to retrieve and optimize an image file stored on the se
21
21
22
22
### Example Request in Postman
23
23
1. Set the request method to **GET**.
24
-
2. Set the URL to: `{{url}}/source/v1/files/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover`
24
+
2. Set the URL to: `{{url}}/assets/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover`
25
25
3. (Optional) Add any required headers.
26
26
4. Click **Send** to retrieve and optimize the image.
27
27
28
28
### Example cURL
29
29
```sh
30
-
curl -X GET "{{url}}/source/v1/files/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover"
30
+
curl -X GET "{{url}}/assets/image/sample.png?fm=webp&q=80&w=300&h=300&fit=cover"
0 commit comments