AI Tools Suite
Sentiment Analysis
AI Tools Suite
Sentiment Analysis
Sentiment Analysis
POST https://openapi.akool.com/api/open/v3/content/analysis/sentiment
Request Headers
| Parameter | Value | Description |
|---|---|---|
| Authorization | Bearer token | Your API Key used for request authorization. You can get from https://openapi.akool.com/api/open/v3/getToken api. |
Body Attributes
| Parameter | Type | Value | Description |
|---|---|---|---|
| url | String | The video url or image url. | |
| type | Number | 1: image 2:video | |
| language | String | When type=2, the language of the video needs to be provided。 Supplying the input language in ISO-639-1 format | |
| 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": "", "status": 1 } | _id: Interface returns data, status: the status of video： [1:queueing, 2:processing, 3:completed, 4:failed] |
Example
Body
{
"type":1, // 1:image 2:video
"url":"https://drz0f01yeq1cx.cloudfront.net/1714023431475-food.jpg",
"webhookUrl":"http://localhost:3004/api/v3/webhook"
}
Request
Response
{
"code": 1000,
"msg": "OK",
"data": {
"create_time": 1710757900382,
"uid": 101690,
"type": 1,
"status": 1, // current status of content： 【1：queueing（The requested operation is being processed），2：processing（The requested operation is being processing），3：completed（The request operation has been processed successfully），4：failed（The request operation processing failed）】
"webhookUrl": "http://localhost:3007/api/open/v3/test/webhook",
"result": "",
"_id": "65f8180c24d9989e93dde3b6",
"__v": 0
}
}
Get analysis Info Result
GET https://openapi.akool.com/api/open/v3/content/analysis/infobyid?_id=662df7928ee006bf033b64bf
Request Headers
| Parameter | Value | Description |
|---|---|---|
| Authorization | Bearer token | Your API Key used for request authorization. You can get from https://openapi.akool.com/api/open/v3/getToken api. |
Query Attributes
| Parameter | Type | Value | Description |
|---|---|---|---|
| _id | String | NULL | video db id: You can get it based on the _id field returned by https://openapi.akool.com/api/open/v3/content/analysis/sentiment . |
Response Attributes
| Parameter | Type | Value | Description |
|---|---|---|---|
| code | int | 1000 | Interface returns business status code(1000:success) |
| msg | String | OK | Interface returns status information |
| data | Object | { status:1, _id:"", result:"" } | video_status: the status of video：【1:queueing, 2:processing, 3:completed, 4:failed】 result: sentiment analysis result【POSITIVE related information, NEGATIVE related information】 _id: Interface returns data |
Example
Request
Response
{
"code": 1000,
"msg": "OK",
"data": {
"_id": "662e20b93baa7aa53169a325",
"uid": 100002,
"status": 3,
"result": "POSITIVE"
}
}
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 | 1008 | The content you get does not exist |
| code | 1009 | You do not have permission to operate |
| code | 1101 | Invalid authorization or The request token has expired |
| code | 1102 | Authorization cannot be empty |
| code | 1200 | The account has been banned |
| code | 1201 | create audio error, please try again later |
| code | 1202 | The same video cannot be translated lipSync in the same language more than 1 times |
| code | 1203 | video should be with audio |