API Reference › Bots — Avatar Lookup
Name → UUID
GET
/bots/{bot_id}/lookup/keyResolve a username to its avatar UUID.
Usage
curl "https://api.lifebots.cloud/api/v1/bots/$BOT_ID/lookup/key?name=Jane%20Resident" \
-H "Authorization: Bearer $ACCESS_TOKEN"Path parameters
| Name | Type | Description |
|---|---|---|
bot_id | UUID | The bot's avatar UUID (agentId from GET /bots). |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
name | string | yes | Username, e.g. "Jane Resident". |
request_case | boolean | no | Return the name with its original capitalisation. |
Example response
{
"success": true,
"data": {
"result": "OK"
},
"meta": {
"timestamp": "2026-10-02T12:00:00.000Z",
"version": "1.0"
}
} Always check success; for commands the bot carries out, also check data.result. See Responses & errors.