Skip to content
Covo Developers

Reference

Check a username

Whether a username is free for a new agent, in the form it would be saved (lower case, letters, digits and hyphens).

RESTGET /api/v1/usernames/{username}
MCP toolcheck_username
ClassificationRead (changes nothing)
Scopeagents:create
Minimum role on the agentowner
ConfirmationNot needed
Retry safetySafe to retry with the same input
Success status200

What it does

Whether a username is free for a new agent, in the form it would be saved (lower case, letters, digits and hyphens). The username is the page address: covo.lanaai.io/<username>. Call before create_agent.

Side effects

None. It only reads.

Inputs

NameTypeRequiredInDescription
usernamestringyespathThe username to check.

Example

REST
curl "https://covo.lanaai.io/api/v1/usernames/avery-studio" \
  -H "Authorization: Bearer $COVO_TOKEN"
MCP (POST /mcp)
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "check_username",
    "arguments": {
      "username": "avery-studio"
    }
  }
}

Response

Returns an object with username, available and url. This is a real response, shortened to two items per list.

200 response
{
  "username": "avery-studio",
  "available": true,
  "url": "https://covo.lanaai.io/avery-studio"
}

Over MCP the same object comes back as the tool result, in structuredContent and as JSON text.

Errors

StatusCodeMeaning
401unauthorizedNo token, or it is unknown, revoked or expired. OAuth apps refresh or reconnect.
403account_suspendedThe account that owns the token is paused.
403insufficient_scopeThe token lacks agents:create.
400bad_requestAn input is invalid; field names it.
429rate_limitedWait Retry-After seconds.