Skip to main content
POST
/
api
/
portrait
/
effects
/
live-photo
Live Photos
curl --request POST \
  --url https://www.ailabapi.com/api/portrait/effects/live-photo \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image_target='@example-file' \
  --form 'type=<string>'
{
  "request_id": "",
  "log_id": "",
  "error_code": 0,
  "error_code_str": "",
  "error_msg": "",
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "data": {
    "video": ""
  }
}

​
Request

  • URL: https://www.ailabapi.com/api/portrait/effects/live-photo
  • Method: POST
  • Content-Type: multipart/form-data

​
Image requirements

  • Image format: JPEG JPG PNG BMP
  • Image size: No more than 5 MB.
  • Image resolution: Less than 4096x4096px.

​
Headers

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

​
Body

FieldRequiredTypeScopeDefaultDescription
image_targetYESfile
typeNOinteger0, 100`: Avatar version.`, 1: Full body version.

​
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.
+videostringReturns the base64 encoded string of the generated video.

​
Response Example

{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "video": ""
  }
}

​
Sample Code

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
image_target
file
​
type
string

Live photo type.

  • 0: Avatar version.
  • 1: Full body version.

    • Response

    200 - application/json

    Success

    The response is of type object.