Skip to main content
POST
/
language
/
analyze
Analyze
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": [],
  "meta": {
    "foo": "bar"
  }
}
'
{
  "request": {
    "document": {
      "value": "<string>",
      "mime_type": "<string>",
      "language": "<string>",
      "meta": {}
    },
    "analyses": [],
    "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": {}
}

Documentation Index

Fetch the complete documentation index at: https://docs.cxconnect.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
document
object
analyses
enum<string>[]
Available options:
sentiment,
entities,
categories,
moderation
meta
object
Example:
{ "foo": "bar" }

Response

Successful analyze response

request
object
entities
object
sentiment
object
moderation
object
categories
object
meta
object