Naming Convention API

The Naming Convention API checks entity names in article fields against CoinPost naming rules.

Base URL

https://api.coinpost.ai/naming-convention/v1

Authentication

Send the API key in the CP-X-API-KEY header.

CP-X-API-KEY: <your-api-key>

Endpoints

• POST /articles/scan — Find naming violations and return correction previews
• POST /articles/apply — Apply corrections marked as safe for automatic use

Article fields

The service scans title, summary, content, and tags. content and tags are optional. The language field accepts en, zh, or ja.

Offsets in matches and corrections are UTF-8 byte offsets, not character indexes.

Behavior

• /articles/scan stores detected violations by default. Set persist to false to skip storage.
• The corrected_article returned by /articles/scan is a preview and can contain corrections that require approval.
• /articles/apply includes only corrections whose rule has auto_fix=true. It returns corrected article data but does not update an external article system or store violations.