logo
0%

Image Enlarge API

Our image enlarger uses sophisticated AI to increase image resolution, optimized to deliver amazing quality for product images, AI images, and images of people. Our proprietary AI technology is engineered to maintain detail and color accuracy, resulting in images that are free from typical upscaling artifacts. .

Endpoint: (POST) https://stagingportal.neuronus.net/api/image-enlarger

Request Parameters

  • image (file) required

    The image file to be enlarged (JPEG, PNG, or JPG, max 3MB) .

  • noise (enum) required

    Level of noise reduction where -1 no noise reduction (must be from -1, 0, 1, 2, 3).

  • scale (enum) required

    Scaling factor for image enlargement (must be from 1, 2, 3, 4, 8).

  • format (enum) required

    Output format for the enlarged image (must be from PNG, WebP, JPG, JPEG).

Request Headers

  • X-Neurnous-Api-Key:
    Your API key.
  • X-Neurnous-Secret-Key:
    Your secret key.

Response

  • Success Response:
    • HTTP Status Code: 200 OK
    • Body:
    {
        "message":"Success.",
        "success":true,
        "download_url":"https://stagingportal.neuronus.net/storage/images/1x_GO3ZtFnW7j_1701844208.png",
        "total_requests":50,
        "used_request":5,
        "remaining_requests": 45
    }
    
  • Error Response:
    • HTTP Status Code: 401 Unauthorized
    • Body:
    {
        "message": "false.",
        "success": false,
        "message": "Invalid API key or secret key"
    }        
    
    • HTTP Status Code: 429 Too Many Requests
    • Body:
    {
        "message":"false.",
        "success":false,
        'message':'You already used allowed image requests, please upgrade your subscription for more requests.'
    }
    
    • HTTP Status Code: 422 Unprocessable Entity
    • Body:
    {
        "message":"false.",
        "success": false,
        "errors": {
            "image": [
            "The image field is required."
            ]
        }
    }
    

Test End Point

Response (Test end point result will be shown here)

example:
{
    "message":"Success.",
    "success":true,
    "download_url": "https://stagingportal.neuronus.net/storage/images/1x_GO3ZtFnW7j_1701844208.png",
    "total_requests": 50,
    "used_request": 5,
    "remaining_requests": 45
}

Get Request Details API

Endpoint: (GET) https://stagingportal.neuronus.net/api/image-enlarger-get-requests

Description

This API retrieves details about the user's image enlargement requests, including the total number of allowed requests, the number of used requests in the current month, and the remaining available requests.

Request Headers

  • X-Neurnous-Api-Key:
    Your API key.
  • X-Neurnous-Secret-Key:
    Your secret key.

Response

  • Success Response:
    • HTTP Status Code: 200 OK
    • Body:
    {
        "message": "Success.",
        "success": true,
        "total_requests": 100,
        "used_request": 25,
        "remaining_requests": 75
    }
    
  • Error Response:
    • HTTP Status Code: 401 Unauthorized
    • Body:
    {
        "message": "false.",
        "success": false,
        "message": "Invalid API key or secret key"
    }