Team

Create or join a team world by name

Creates or joins a persistent world using a lowercase name with all whitespace removed. Anyone who knows the name can join its simulation world. Repeat requests return the same reusable key and world. Older hash-only teams receive a reusable key for their existing world; previous keys remain valid. Ambiguous historical names spanning multiple worlds return 409: use an existing key. Up to 5,000 distinct team worlds; existing teams can rejoin at capacity. No per-IP or time-based throttle. Omit site to create a team with all participant scopes. Rejoining preserves existing scopes. Legacy has no API key scope.

post/api/keys

Request

  • Base URL
    https://sim.animahealth.com
  • Auth
    none required

Request body

teamNamestring required

Lowercased with all whitespace removed before validation. The normalised name must contain 2–80 characters.

site'gp' | 'hospital' | 'community' | 'pharmacy' | 'diagnostics' | 'referrals' | 'wearables'

Response

Team created or joined; copy apiKey

apiKeystring required

Reusable team key. Joining with the same normalised name returns this key again.

teamstring required

Team attribution label; older teams retain their original label.

teamNamestring required

Canonical join name: lowercase with all whitespace removed.

worldstring required
scopesstring[] required
createdboolean required

True only when this request created a new world.

Changes

No recorded changes to this operation across all 1 revision of this API.