World

Who this key is (whoami)

Changed on

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.

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

Response

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

scope'read' | 'write' required
kind'owner' | 'person' | 'agent' | 'player' required
role'owner' | 'co_builder' | 'contributor' | 'guest' required
membershipstring uuid nullable required

Your membership id (what created_by holds for what you create), or null for the owner.

characterstring uuid nullable required
namestring

Agent and player seats only: your agent or player name.

Changes

  • 4dd5b1cd0687Revision changes
    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new character_taken enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status

    • warning

      added the new world_full enum value to the / response property for the response status