Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
curl --request POST \
--url https://test.api.cxconnect.ai/language/analyze \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"document": {
"value": "<string>",
"mime_type": "<string>",
"language": "<string>",
"meta": {}
},
"analyses": [
"sentiment"
],
"meta": {
"foo": "bar"
}
}'
{
"request": {
"document": {
"value": "<string>",
"mime_type": "<string>",
"language": "<string>",
"meta": {}
},
"analyses": [
"sentiment"
],
"meta": {
"foo": "bar"
}
},
"entities": {
"entities": [
{
"name": "<string>",
"type": "<string>",
"language": "<string>",
"mentions": 123,
"meta": {}
}
],
"meta": {}
},
"sentiment": {
"sentiment": "<string>",
"magnitude": 123,
"score": 123,
"language": "<string>",
"meta": {}
},
"moderation": {
"categories": [
{
"name": "<string>",
"confidence": 123
}
],
"meta": {}
},
"categories": {
"categories": [
{
"name": "<string>",
"confidence": 123
}
],
"meta": {}
},
"meta": {}
}
The analyze endpoint performs one or many analysis tasks on the input document
curl --request POST \
--url https://test.api.cxconnect.ai/language/analyze \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"document": {
"value": "<string>",
"mime_type": "<string>",
"language": "<string>",
"meta": {}
},
"analyses": [
"sentiment"
],
"meta": {
"foo": "bar"
}
}'
{
"request": {
"document": {
"value": "<string>",
"mime_type": "<string>",
"language": "<string>",
"meta": {}
},
"analyses": [
"sentiment"
],
"meta": {
"foo": "bar"
}
},
"entities": {
"entities": [
{
"name": "<string>",
"type": "<string>",
"language": "<string>",
"mentions": 123,
"meta": {}
}
],
"meta": {}
},
"sentiment": {
"sentiment": "<string>",
"magnitude": 123,
"score": 123,
"language": "<string>",
"meta": {}
},
"moderation": {
"categories": [
{
"name": "<string>",
"confidence": 123
}
],
"meta": {}
},
"categories": {
"categories": [
{
"name": "<string>",
"confidence": 123
}
],
"meta": {}
},
"meta": {}
}
The access token received from the authorization server in the OAuth 2.0 flow.
Was this page helpful?