---
title: "Who this key is (whoami)"
method: GET
path: "/api/v2/me"
tags: ["World"]
---

# Who this key is (whoami)

`GET /api/v2/me`

## Request

- Base URL: `https://www.onlyworlds.com`
- URL: `https://www.onlyworlds.com/api/v2/me`
- Auth: one of:
  - API key in header `API-Key`
  - API key in header `API-Key` and API key in header `API-Pin`

Any key. An owner-minted or classic key answers as the owner (membership null, character = the world's owner_character); a member or agent-seat key answers as its membership. A read route: no PIN for `ow_` keys; a classic key on a private world sends its PIN. A PIN that is sent is checked: for a member key, against the member's own account PIN (an agent seat's secret), so a wrong one is a 401 here and not at the first write. A player seat (kind player, no account, read only) has no PIN: one it sends is ignored. `character` is null when the world's owner hid that Character from this key.

## Response `200`

The world, the key's scope, and who it acts as.

- object
  - `world` object, required
    - `id` string, uuid, required
    - `name` string, required
  - `scope` 'read' | 'write', required
  - `kind` 'owner' | 'person' | 'agent' | 'player', required
  - `role` 'owner' | 'co_builder' | 'contributor' | 'guest', required
  - `membership` string, uuid, nullable, required: Your membership id (what created_by holds for what you create), or null for the owner.
  - `character` string, uuid, nullable, required
  - `name` string: Agent and player seats only: your agent or player name.

## Other responses

- `401`: Missing, invalid or revoked credential, or a wrong PIN (authentication_error; code key_revoked for a revoked key, invalid_credentials otherwise).
- `429`: Too many failed PIN attempts; see the Retry-After header (rate_limited). Or too many requests: over the request budget (code too_many_requests, type rate_limited): 300 requests a minute per key or account token, 60 a minute per address for a request with neither. Retry after the Retry-After header's seconds.
- `503`: The server is busy: every request slot stayed full for 10 s (code server_busy, type api_error). Retry after the Retry-After header's seconds.

## Changes

- **2026-10-20** `78df39c4c62e`: 3 warning
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `401`
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `429`
  - added the new `known_of_not_writable` enum value to the `error/code` response property for the response status `503`
- **2026-10-20** `4dd5b1cd0687`: 6 warning
  - added the new `character_taken` enum value to the `error/code` response property for the response status `401`
  - added the new `character_taken` enum value to the `error/code` response property for the response status `429`
  - added the new `character_taken` enum value to the `error/code` response property for the response status `503`
  - added the new `world_full` enum value to the `error/code` response property for the response status `401`
  - …2 more

[Operation history](https://skmtc.dev/onlyworlds/apis/onlyworlds-api/changes/api/v2/me/get.md)

---

[API](https://skmtc.dev/onlyworlds/apis/onlyworlds-api.md) · [All operations](https://skmtc.dev/onlyworlds/apis/onlyworlds-api/llms.txt) · [OpenAPI document](https://skmtc.dev/onlyworlds/apis/onlyworlds-api/revisions/1752622ae8ce?raw)