Soul Machines · Authentication Profile

Soul Machines Authentication

Authentication

Soul Machines secures its APIs with apiKey and oauth2 across 2 declared security schemes, as derived from its OpenAPI definitions. OAuth 2.0 is offered via the tokenServer flow(s).

CompanyEnterpriseArtificial IntelligenceDigital HumansAvatarsConversational AICustomer ExperienceSDKWeb SDK

Methods: apiKey, oauth2 Schemes: 2 OAuth flows: tokenServer API key in: config

Security Schemes

ApiKey apiKey

· in: config ()

TokenServer oauth2

scheme: bearer

Source

Authentication Profile

generated: '2026-07-21'
method: searched
source: https://docs.soulmachines.com/web-sdk/ and https://github.com/soulmachines/react-reference-ui-public
docs: https://docs.soulmachines.com/web-sdk/
summary:
  types: [apiKey, oauth2]
  api_key_in: [config]
  oauth2_flows: [tokenServer]
  notes: >-
    A Digital Person session is authenticated in one of two modes, selected per
    persona (react-reference-ui REACT_APP_PERSONA_AUTH_MODE): 0 = API key, or
    1 = token server (JWT). API keys are configured in DDNA Studio persona
    preferences. Token-server auth is used when an orchestration server handles
    NLP; the client fetches a short-lived JWT from a token endpoint and presents
    it to the dh.soulmachines.cloud session server.
schemes:
- name: ApiKey
  type: apiKey
  in: config
  description: API key configured in DDNA Studio persona preferences; supplied to the Web SDK to connect to a persona.
  auth_mode: 0
- name: TokenServer
  type: oauth2
  scheme: bearer
  description: JWT issued by a developer-operated token server, exchanged for a Digital Person session on the session server. Used with an orchestration server for non-native NLP or custom backend logic.
  auth_mode: 1
  token_endpoint: developer-operated (REACT_APP_TOKEN_URL)
session_server: https://dh.soulmachines.cloud