# Text Similarity Calculator
Compare two texts and return a semantic similarity score.
## API Overview
- **HTTP Protocol:** HTTPS
- **HTTP Method:** POST
- **HTTP Endpoint:** https://api.gugudata.io/v1/text/similarity
- **Response Type:** application/json; charset=utf-8
- **DEMO Endpoint:** https://api.gugudata.io/v1/text/similarity/demo
- **Live Demo:** https://gugudata.io/demo/textsimilarity
- **Postman:** https://www.postman.com/gugudata/gugudata-io
- **LLM Page:** https://gugudata.io/details/textsimilarity/llm
- **Raw Markdown:** https://gugudata.io/details/textsimilarity/llm.md
## Remote MCP
- **MCP Endpoint:** https://mcp.gugudata.io/mcp
- **MCP Guide:** https://gugudata.io/mcp/
- **Authorization:** OAuth authorization opens in the browser; do not paste appkeys into MCP clients.
- **Tool Scope:** MCP clients receive GuGuData API tools available to the authorized account.
## Data & API Features
- Semantic comparison: Compare the meaning of two texts beyond exact word matches.
- Normalized score: Receive a compact similarity score for each submitted text pair.
- Multilingual text: Compare supported text in English, Chinese, and other languages.
- Duplicate review: Prioritize potentially similar records for editorial or manual review.
- Content matching: Compare descriptions, questions, documents, or search results in your workflow.
- Simple JSON integration: Submit two text fields and use the returned score in downstream applications.
## API Request Parameters
| Name | Type | Is Required | Default Value | Remark |
| --- | --- | --- | --- | --- |
| appkey | string | true | YOUR_APPKEY | API key used to authenticate the request. |
| content1 | string | true | | First nonblank text to compare. |
| content2 | string | true | | Second nonblank text to compare. |
## API Response Parameters
| Name | Type | Remark |
| --- | --- | --- |
| dataStatus | object | Legacy response metadata. `dataStatus.statusCode` is not the HTTP status code for this endpoint family. |
| dataStatus.requestParameter | string | Privacy-safe summary of the normalized request. |
| dataStatus.statusCode | integer | Application-level status code. |
| dataStatus.statusDescription | string | Human-readable application status message. |
| dataStatus.responseDateTime | string | Time at which the response was generated. |
| dataStatus.dataTotalCount | integer | Number of matching or returned records for this request. |
| data | object | Object containing the semantic similarity result. |
| data.similarity | string | Similarity score returned as a decimal string by the current v1 contract. |
## API Response Status Codes
| Status Code | Explanation of Status Code | Remarks |
| --- | --- | --- |
| 200 | Request processed successfully. | Some endpoints expose a separate application-level status field in the response body, such as `dataStatus.statusCode`. |
| 400 | Invalid request parameters or request format. | Check required fields, data types, and request body format. |
| 401 | Missing or unknown application key. | Provide a valid `appkey` with the request. |
| 403 | The application key is recognized but access is not allowed. | The key may be expired, inactive, or not permitted for the requested API. |
| 429 | Request rate or trial usage limit exceeded. | Reduce request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue. |
| 500 | Internal service error. | Retry later or contact support if the error persists. |
| 503 | Upstream service unavailable. | Retry later; the requested upstream dependency is temporarily unavailable. |
## cURL Example
```bash
curl --location 'https://api.gugudata.io/v1/text/similarity?appkey=YOUR_APPKEY' --request POST --header 'Content-Type: application/json' --data '{
"content1": "YOUR_VALUE",
"content2": "YOUR_VALUE"
}'
```