Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
列出和管理用于分析 AI 回复的品牌备用名称。
fuzzy 匹配（容忍大小写和空格差异）或 exact 匹配（要求完整词匹配）。
GET /projects/{project_id}/aliases
curl "https://topify-customer-api-production.up.railway.app/api/public/v1/projects/{project_id}/aliases" \
-H "X-API-Key: tk_live_..."
{
"success": true,
"data": {
"project_id": "a1b2c3d4-...",
"brand_name": "Acme",
"aliases": [
{ "name": "ACME Corp", "match_type": "fuzzy" }
],
"limit": 20,
"remaining": 19
}
}
POST /projects/{project_id}/aliases
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
alias | string | 是 | 1-100 个字符的别名文本 |
match_type | string | 否 | fuzzy（默认）或 exact |
curl -X POST "https://topify-customer-api-production.up.railway.app/api/public/v1/projects/{project_id}/aliases" \
-H "X-API-Key: tk_live_..." \
-H "Content-Type: application/json" \
-d '{"alias":"ACME Corp","match_type":"fuzzy"}'
next_actions。
PATCH /projects/{project_id}/aliases
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
original_alias | string | 是 | 现有别名；匹配不区分大小写 |
new_alias | string | 是 | 新的别名文本 |
match_type | string | 否 | 新的 fuzzy 或 exact 设置；省略则保留当前设置 |
curl -X PATCH "https://topify-customer-api-production.up.railway.app/api/public/v1/projects/{project_id}/aliases" \
-H "X-API-Key: tk_live_..." \
-H "Content-Type: application/json" \
-d '{"original_alias":"ACME Corp","new_alias":"Acme Corporation","match_type":"exact"}'
DELETE /projects/{project_id}/aliases?alias={alias}
curl -X DELETE "https://topify-customer-api-production.up.railway.app/api/public/v1/projects/{project_id}/aliases?alias=Acme%20Corporation" \
-H "X-API-Key: tk_live_..."
| 状态码 | 错误代码 | 原因 |
|---|---|---|
400 | ALIAS_EMPTY 或 ALIAS_TOO_LONG | 别名文本无效 |
404 | ALIAS_NOT_FOUND | 请求的别名不存在 |
409 | ALIAS_DUPLICATE | 已存在不区分大小写的重复别名 |
429 | ALIAS_LIMIT_REACHED | 项目已有 20 个别名 |