مرجع الواجهة

فحص النص

فحص النص بحثاً عن البيانات الحساسة. يبحث في نص الطلب عن الكيانات المطلوب كشفها، ويُعيد كل مطابقة على شكل نطاق من الأحرف مع نوع الكيان ودرجة الثقة. وتُستبعد المطابقات التي تقل درجة ثقتها عن حد الثقة.

POST
/scan

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for the scan endpoint: the text to inspect and which entity types to detect.

Response Body

application/json

application/json

curl -X POST "https://example.com/scan" \  -H "Content-Type: application/json" \  -d '{    "text": "string"  }'
{  "results": [    {      "start": 0,      "end": 0,      "score": 0,      "entity_type": "string"    }  ],  "usage": {    "input_tokens": 0,    "inference_ms": 0  }}
{  "detail": [    {      "loc": [        "string"      ],      "msg": "string",      "type": "string",      "input": null,      "ctx": {}    }  ]}
© 2026 قُبة