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

​
Request

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

​
Image requirements

  • Image format: JPEG JPG PNG
  • Image size: No more than 3 MB.
  • Image resolution: Larger than 100x100px, smaller than 2000x2000px.

​
Headers

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

​
Body

FieldRequiredTypeScope
imageYESfile
typeYESstringMore Details

​
type

CategorytypeDescription
Full-Body CartoonizationjpcartoonJapanese Manga (I)
animeJapanese Manga (II)
claborateChinese fine brushwork painting
hongkongHong Kong-style comic style
comicComic
animation3d3D Animation
handdrawnhand-painted
sketchPencil drawing (I)
fullPencil drawing (II)
artstyleArtistic effects
classic_cartoonRetro Cartoon
tccartoonMoe Manga
hkcartoonChina Comics
Facial Cartoonization3d_cartoon3D cartoon
pixarPixar
pixar_plusPixar Pro
angelAngel
angel_plusAngel Pro
demonDemon
ukiyoe_cartoonUkiyo-e
amcartoonAmerican Manga
3d3D Effects
3d_game3D game effects
Avatar CartoonizationwesternWestern
avatarAvatar
headPencil drawing (head)

​
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.
+image_urlstringResulting image URL address.
The URL address is a temporary address, valid for 24 hours, and will not be accessible after it expires. If you need to save the file for a long time or permanently, please visit the URL address within 24 hours and download the file to your own storage space.

​
Response Example

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

​
Sample Code

[👉 Online Experience 👈(https://www.ailabtools.com/portrait-cartoonization-example)]If you’d like to see the actual effects, please visit the experience page for a trial.

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
image
file
​
type
string

Cartoon effect. <li>jpcartoon: Japanese Manga (I)</li> <li>anime: Japanese Manga (II)</li> <li>claborate: Chinese fine brushwork painting</li> <li>hongkong: Hong Kong-style comic style</li> <li>comic: Comic</li> <li>animation3d: 3D Animation</li> <li>handdrawn: hand-painted</li> <li>sketch: Pencil drawing (I)</li> <li>full: Pencil drawing (II)</li> <li>artstyle: Artistic effects</li> <li>classic_cartoon: Retro Cartoon</li> <li>tccartoon: Moe Manga</li> <li>hkcartoon: China Comics</li> <li>3d_cartoon: 3D cartoon</li> <li>pixar: Pixar</li> <li>pixar_plus: Pixar Pro</li> <li>angel: Angel</li> <li>angel_plus: Angel Pro</li> <li>demon: Demon</li> <li>ukiyoe_cartoon: Ukiyo-e</li> <li>amcartoon: American Manga</li> <li>3d: 3D Effects</li> <li>3d_game: 3D game effects</li> <li>western: Western</li> <li>avatar: Avatar</li> <li>head: Pencil drawing (head)</li>

Response

200 - application/json

Success

The response is of type object.