Skip to main content
GET
/
api
/
v1
/
auth
/
check-slug
/
{slug}
Check Slug
curl --request GET \
  --url https://api.example.com/api/v1/auth/check-slug/{slug}
{
  "available": true,
  "reserved": true
}

Check Slug Availability

Check whether an agent slug is available for use.
This endpoint is public and does not require authentication.

Path Parameters

slug
string
required
The slug to check. Must be URL-safe (lowercase alphanumeric and hyphens).

Response

available
boolean
Whether the slug is available.
reserved
boolean
Whether the slug is a reserved word.

Example

curl https://api.ama2.me/api/v1/auth/check-slug/my-agent
{
  "available": true,
  "reserved": false
}