POST /text/classification

Initiates a new text analysis request.

Example Request

 

curl -H 'x-api-key: <YOUR_API_KEY_HERE>' -H 'Content-Type: application/json' -X POST -d '{"text":"Kubernetes (also known as k8s or kube) is an open source container orchestration platform that automates many of the manual processes", "languageCode": "en"}'  https://verity-api.gumgum.com/text/classification

Example Response

{   "uuid": "c7bcbe04-ea77-4808-8e91-28d325d1b1fc",   "acceptedAt": "2020-06-25T23:09:41.729Z" }

Header

Field

Type

Description

Optional/Required

Field

Type

Description

Optional/Required

x-api-key

String

GumGum authentication token.

Required

Content-Type

String (value: application/json)

Describing the MIME type for the application as being JSON.

Required

 Body

Parameter name

Type

Description

Optional/Required

Parameter name

Type

Description

Optional/Required

text

String

Text to be analyzed, up to a maximum of 20,000 characters.

Required

languageCode

String

ISO 639-1 Language Code for the text to be analyzed. If no language code is specified, Verity performs language detection against supported languages. If language detection fails or the specified language code is invalid or unsupported, then a HTTP 400 error code is returned. See Verity Language Support Grid.

Optional

callbackUrl

String

URL to target server listening for Verity data.

Optional


The contents of these documents and any attachments contain GumGum, Inc. confidential information and are legally protected from disclosure.