Skip to content

Scan articles

POST
/articles/scan

Scans article fields for entity-name matches and naming-rule violations. The response includes every deterministic correction as a preview, including corrections that require approval. Detected violations are stored by default; set persist to false to skip storage.

Authorizations

apiKeyAuth

CoinPost API key

Type
API Key (header: CP-X-API-KEY)

Request Body

application/json
JSON
{
  
"articles": [
  
  
{
  
  
  
"id": "string",
  
  
  
"title": "string",
  
  
  
"summary": "string",
  
  
  
"content": "string",
  
  
  
"tags": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"source": "string",
  
  
  
"language": "string"
  
  
}
  
],
  
"persist": true
}

Responses

Scan results in the same order as the request articles

application/json
JSON
[
  
{
  
  
"article_id": "string",
  
  
"matches": [
  
  
  
{
  
  
  
  
"article_id": "string",
  
  
  
  
"entity_id": "string",
  
  
  
  
"field": "string",
  
  
  
  
"matched_text": "string",
  
  
  
  
"start_offset": 0,
  
  
  
  
"end_offset": 0
  
  
  
}
  
  
],
  
  
"violations": [
  
  
  
{
  
  
  
  
"article_id": "string",
  
  
  
  
"entity_id": "string",
  
  
  
  
"rule_id": "string",
  
  
  
  
"field": "string",
  
  
  
  
"matched_text": "string",
  
  
  
  
"start_offset": 0,
  
  
  
  
"end_offset": 0,
  
  
  
  
"suggested_name": "string",
  
  
  
  
"language": "string",
  
  
  
  
"violation_type": "string",
  
  
  
  
"severity": "string",
  
  
  
  
"auto_fixable": true
  
  
  
}
  
  
],
  
  
"corrections": [
  
  
  
{
  
  
  
  
"article_id": "string",
  
  
  
  
"entity_id": "string",
  
  
  
  
"rule_id": "string",
  
  
  
  
"field": "string",
  
  
  
  
"original_text": "string",
  
  
  
  
"corrected_text": "string",
  
  
  
  
"language": "string",
  
  
  
  
"start_offset": 0,
  
  
  
  
"end_offset": 0,
  
  
  
  
"auto_fixable": true,
  
  
  
  
"requires_approval": true
  
  
  
}
  
  
],
  
  
"corrected_article": {
  
  
  
"id": "string",
  
  
  
"title": "string",
  
  
  
"summary": "string",
  
  
  
"content": "string",
  
  
  
"tags": [
  
  
  
  
"string"
  
  
  
],
  
  
  
"source": "string",
  
  
  
"language": "string"
  
  
}
  
}
]

Playground

Authorization
Body

Samples