Skip to main content

AILabTools API - Intelligent Composition - API

draft: true​

Important Announcement: The API Documentation Has Been Fully Updated

This API documentation has been completely restructured with an improved and clearer format. The current page will no longer receive active updates or maintenance. For the most accurate and up-to-date information, please switch to the new documentation.

View New Docs

Request​

  • URL: https://www.ailabapi.com/api/image/editing/intelligent-composition
  • Method: POST
  • Content-Type: multipart/form-data

Image requirements​

  • Image format: JPEG JPG PNG BMP WEBP
  • Image size: No more than 3 MB.
  • Image resolution: Larger than 32x32px, smaller than 4096x4096px.

Headers​

FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

Body​

FieldRequiredTypeScopeDefaultDescription
imageYESfile
num_boxesNOinteger
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
  • 9
  • 10
    		• 5The number of output boxes.

    Response​

    Response Field Handling Flow

    1. Handle Public Response Fields

      Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.

    2. Handle Business Response Fields

      If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

    Public Response Fields​

    Viewing Public Response Fields and Error Codes

    Business Response Fields​

    FieldTypeDescription
    dataobjectThe content of the result data returned.
    +elementsarrayIntelligent composition results.
    ++min_xintegerThe horizontal coordinate of the upper-left corner of the output box.
    ++max_xintegerThe horizontal coordinate of the lower-right corner of the output box.
    ++min_yintegerThe vertical coordinate of the upper-left corner of the output box.
    ++max_yintegerThe lower-right vertical coordinate of the output box.
    ++scorefloatThe higher the score, the better the composition. 3.8 or above is recommended as a better composition score.

    Response Example​

    {
      "request_id":     "",
      "log_id":         "",
      "error_code":     0,
      "error_msg":      "",
      "error_detail":   {
        "status_code":  200,
        "code":         "",
        "code_message": "",
        "message":      ""
      },
      "data": {
        "elements": [
          {
            "min_x": 0,
            "max_x": 0,
            "min_y": 0,
            "max_y": 0,
            "score": 0
          }
        ]
      }
    }

    Sample Code​

    Last updated on