AI Tools Suite
Reage
The resources (image, video, voice) generated by our API are valid for 7 days. Please save the relevant resources as soon as possible to prevent expiration.
Image Reage
Request Headers
Parameter | Value | Description |
---|---|---|
Authorization | Bearer token | Your API Key used for request authorization |
Body Attributes
Parameter | Type | Value | Description |
---|---|---|---|
targetImage | Array | [{path:"",opts:""}] | Replacement target image information(Each array element is an object, and the object contains 2 properties, path:Links to faces detected in target images. opts: Key information of the face detected in the target image【You can get it through the face https://sg3.akool.com/detect API, You can get the landmarks_str value returned by the api interface as the value of opts) |
face_reage | Int | [-30, 30] | Reage ranges |
modifyImage | String | Modify the link address of the image | |
webhookUrl | String | Callback url address based on HTTP request |
Response Attributes
Parameter | Type | Value | Description |
---|---|---|---|
code | int | 1000 | Interface returns business status code(1000:success) |
msg | String | Interface returns status information | |
data | Object | {_id:"",url: "",job_id: ""} | _id : Interface returns data url: faceswwap result url job_id: Task processing unique id |
Example
Body
Request
Response
Video Reage
Request Headers
Parameter | Value | Description |
---|---|---|
Authorization | Bearer token | Your API Key used for request authorization |
Body Attributes
Parameter | Type | Value | Description |
---|---|---|---|
targetImage | Array | [] | Replacement target image information(Each array element is an object, and the object contains 2 properties, path:Links to faces detected in target images. opts: Key information of the face detected in the target image【You can get it through the face https://sg3.akool.com/detect API, You can get the landmarks_str value returned by the api interface as the value of opts) |
face_reage | Int | [-30,30] | Reage ranges |
modifyVideo | String | Modify the link address of the video | |
webhookUrl | String | Callback url address based on HTTP request |
Response Attributes
Parameter | Type | Value | Description |
---|---|---|---|
code | int | 1000 | Interface returns business status code (1000: success) |
msg | String | Interface returns status information | |
data | Object | { _id: "", url: "", job_id: "" } | _id : Interface returns data, url: faceswap result url, job_id: Task processing unique id |
Example
Body
Request
Response
Get Reage Result List Byids
Request Headers
Parameter | Value | Description |
---|---|---|
Authorization | Bearer token | Your API Key used for request authorization |
Query Attributes
Parameter | Type | Value | Description |
---|---|---|---|
_ids | String | Result ids are strings separated by commas. You can get it by returning the _id field from https://openapi.akool.com/api/open/v3/faceswap/highquality/imgreage or https://openapi.akool.com/api/open/v3/faceswap/highquality/vidreage api. |
Response Attributes
Parameter | Type | Value | Description |
---|---|---|---|
code | int | 1000 | Interface returns business status code (1000: success) |
msg | String | Interface returns status information | |
data | Object | result: [{ faceswap_status: "", url: "", createdAt: "" }] | faceswap_status: faceswap result status (1 In Queue, 2 Processing, 3 Success, 4 Failed), url: faceswap result url, createdAt: current faceswap action created time |
Example
Request
Response
Reage Task cancel
Request Headers
Parameter | Value | Description |
---|---|---|
Authorization | Bearer token | Your API Key used for request authorization |
Body Attributes
Parameter | Type | Value | Description |
---|---|---|---|
job_ids | String | Task id, You can get it by returning the job_id field based on https://openapi.akool.com/api/open/v3/faceswap/highquality/imgreage or https://openapi.akool.com/api/open/v3/faceswap/highquality/vidreage api. |
Response Attributes
Parameter | Type | Value | Description |
---|---|---|---|
code | int | 1000 | Interface returns business status code (1000: success) |
msg | String | Interface returns status information |
Example
Body
Request
Response
Response Code Description
Please note that if the value of the response code is not equal to 1000, the request is failed or wrong
Parameter | Value | Description |
---|---|---|
code | 1000 | Success |
code | 1003 | Parameter error or Parameter can not be empty |
code | 1005 | Operation is too frequent |
code | 1006 | Your quota is not enough |
code | 1007 | The number of people who can have their faces changed cannot exceed 8 |
code | 1101 | Invalid authorization or The request token has expired |
code | 1102 | Authorization cannot be empty |
code | 1200 | The account has been banned |