Skip to content

Aliases

Aliases map alternative tag names to a canonical tag. When users use an alias, it’s automatically resolved to the target tag.

How Aliases Work

When you create an alias doggo → dog:

  • Any time someone uses the tag “doggo”, it’s automatically converted to “dog”
  • Aliases are resolved before tags are stored
  • Multiple aliases can point to the same tag

This lets users tag with natural language (“kitty”, “pupper”) while you maintain consistent data (“cat”, “dog”).

Alias Object

{
"id": "alias-123",
"application_id": "app-123",
"alias": "doggo",
"tag_id": "tag-dog",
"created_at": "2024-01-15T10:30:00Z",
"tag": {
"id": "tag-dog",
"name": "dog"
}
}
FieldTypeDescription
aliasstringAlternative name (1-255 chars)
tag_idUUIDTarget tag this alias resolves to
tagobjectExpanded target tag details

Endpoints

Create Alias

POST /api/v1/applications/{app_id}/aliases

Create a new alias that maps to a tag.

Request:

{
"alias": "doggo",
"tag_id": "tag-dog"
}

Example:

Terminal window
curl -X POST "https://api.taguten.com/api/v1/applications/{app_id}/aliases" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"alias": "doggo",
"tag_id": "tag-dog"
}'

List Aliases

GET /api/v1/applications/{app_id}/aliases

Get all aliases in your application.

Terminal window
curl "https://api.taguten.com/api/v1/applications/{app_id}/aliases" \
-H "Authorization: Bearer YOUR_API_KEY"

Update Alias

PATCH /api/v1/applications/{app_id}/aliases/{alias_id}

Change which tag an alias points to.

Request:

{
"tag_id": "tag-new-target"
}

Delete Alias

DELETE /api/v1/applications/{app_id}/aliases/{alias_id}

Delete an alias. The target tag is not affected.

Terminal window
curl -X DELETE "https://api.taguten.com/api/v1/applications/{app_id}/aliases/{alias_id}" \
-H "Authorization: Bearer YOUR_API_KEY"

Common Use Cases

Misspellings

recieve → receive
seperate → separate

Abbreviations

sci-fi → science fiction
bg → background

Slang / Internet Terms

doggo → dog
pupper → dog
kitty → cat
birb → bird

Language Variations

colour → color
grey → gray