Mindset AI Documentation home page
Search...
⌘K
Ask AI
Search...
Navigation
API Overview
SDK Users API
Home
Are we wrong?
For AI Managers
For AI Developers
Guides & Templates
Overview
Introduction
SDK 2
SDK 2 Overview
Embed agent demo
Embedding an Agent
Front end
Back end
Agent UI color theme
Agent flexible UI
Agent fonts customization
Authentication
Agent and Knowledge Context Provisioning
SDK 2 HTML tags and methods details
Migrating to SDK 2
Best practices and known limitations
API Overview
API Introduction
Contexts API
Context Files API
Labels API
Agent Sessions API
SDK Users API
API playground
Agent Sessions
Context Files
Contexts
Labels
SDK Users
API Overview
SDK Users API
Parameters full description
Note
You can find below the full description of Parameters for the POST method and also what parameters you can expect from the API responses.
If you want to play with the API, please see the
SDK Users API playground
.
SDK Users API playground
POST - Generate an auth token
Parameters:
name [String]
Friendly name to be set for the user. Optional, this is only used when a new user is created. If the user already exists, this parameter is ignored.
externalId [String]
Unique user identifier. Valid characters are A-Za-z0-9_-. Minimum is one (but not both) of externalId or a userEmail
userEmail [String]
email address format user identifier. Deprecated. Prefer using externalId. Minimum is one (but not both) of externalId or a userEmail
accountUids [String[]]
Array of account uids (max 10). The user will be added to these accounts to allow access to restricted agents.
Please see
Best practice: Agent access granted by Account membership
RESPONSE DATA
authToken
String
authentication token for the user, which can be used to authenticate the user in the Mindset SDK
Agent Sessions API
Retrieve a collection of agent sessions
Assistant
Responses are generated using AI and may contain mistakes.