POST
/
v2
/
text-compare
curl --request POST \
  --url https://api.gowinston.ai/v2/text-compare \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "first_text": "<string>",
  "second_text": "<string>"
}'
{
  "status": 123,
  "similarity_score": 123,
  "first_text": {
    "total_word_count": 123,
    "matching_word_count": 123,
    "similarity_percentage": 123,
    "items": [
      {
        "type": "<string>",
        "word_count": 123,
        "index_start": 123,
        "length": 123
      }
    ]
  },
  "second_text": {
    "total_word_count": 123,
    "matching_word_count": 123,
    "similarity_percentage": 123,
    "items": [
      {
        "type": "<string>",
        "word_count": 123,
        "index_start": 123,
        "length": 123
      }
    ]
  },
  "credits_used": 123,
  "credits_remaining": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
The text comparison request body
first_text
string
required

The first text to compare. Maximum 120,000 characters.

Maximum length: 120000
second_text
string
required

The second text to compare against the first text. Maximum 120,000 characters.

Maximum length: 120000

Response

200
application/json
Text comparison response
status
integer

HTTP status code representing the result of the text comparison request

similarity_score
number

Overall similarity score between the two texts (0-100).

0 means no similarity, 100 means identical.

first_text
object
second_text
object
credits_used
integer

The credits_used field represents the number of credits consumed for processing your request. Each text comparison request consumes the total number of words in both texts divided by 2.

credits_remaining
integer

The credits_remaining field shows how many credits you have left in your account after your request has been processed.