Skip to main content
GET
/
v2
/
pals
/
check-username
Check Conferencing Username Availability
curl --request GET \
  --url https://tavusapi.com/v2/pals/check-username \
  --header 'x-api-key: <api-key>'
{
  "available": true
}
For AI agents, use https://docs.tavus.io/openapi.yaml for the full HTTP API contract.
See Google Meet for username rules, allowlists, and scheduling via Google Calendar.

Authorizations

x-api-key
string
header
required

Query Parameters

username
string
required

The username to check. Case-insensitive; stored lowercase.

Response

Availability result

available
boolean

true when the username can be used on tavusinvite.com.

Example:

true

reason
string

Present when available is false.

Example:

"Username is already taken."