Text Analysis API Usage, Sentiment & Content Moderation

Official SDKs & Libraries

Use official SDKs for faster integration across platforms.

Request Flow & Authentication

Use the REST API directly or integrate using the official SDKs shown below.

All requests must be signed using your API Secret . Send the generated signature in the x-signature header.

payload = {
  accountId,
  projectId,
  apiKey,
  text OR texts
}

signature =
HMAC_SHA256(
  JSON.stringify(payload),
  API_SECRET
)

Headers:
x-signature: signature

const creds = {
  apiKey: "YOUR_API_KEY",
  accountId: "YOUR_ACCOUNT_ID"
};

const text = new VoyantClient.TextAnalyzeApiClient({
  credentials: creds,
  projectId: "YOUR_PROJECT_ID"
});

// single
await text.analyze("hello world");

// batch
await text.analyze([
  "hello",
  "world"
]);

POST /v1/text/analyze

{
  "accountId":"...",
  "projectId":"...",
  "apiKey":"...",
  "text":"Hello world"
}

POST /v1/text/analyze/batch

{
  "accountId":"...",
  "projectId":"...",
  "apiKey":"...",
  "texts":[
    "Hello",
    "World"
  ]
}

Response Format

Each request returns probability scores (0 → 1) for different content signals. Higher value = stronger confidence.

{
  "success": true,
  "data": {
    "toxic": 0.0087,
    "obsceneContent": 0.0217,
    "threateningContent": 0.0182,
    "insultingLanguage": 0.0755,
    "identityAttack": 0.1063,
    "sexuallyExplicit": 0.0349,
    "spam": 1,
    "phishing": 0,
    "sentiment": 0.3579
  }
}