​
CRUD APIs

The APIs below are CRUD APIs, meaning you can Create, Read, Update, or Delete data in the Agent Management Studio (AMS) using them.

​
Agents API

The Agents API allows you to programmatically manage agents without needing to enter the Agent Management Studio (AMS).

​
Available Operations

  • Create: Create new agents and set their name, personality, and other attributes
  • Read: Look up existing agents
  • Update: Update existing agents, for example change description, name, personality settings, or assign MCP Servers or Contexts to agents*
  • Delete: Delete existing agents
NOTE: Agents created via the Agent API are the new generation of Mindset Agents and will be visible only through the AMS interface.

​
Resources

​
Contexts API

The Contexts API allows you to programmatically manage knowledge contexts without needing to enter the AMS.

​
Available Operations

  • Create: Create a new context
  • Read: Look up a context, for example using a context name to find its UID and other data, or using a UID to find its name
  • Update: Change the name or other properties
  • Delete: Remove a context

​
Resources

​
Context Files API (Ingestion API)

Also known as the Ingestion API, this API allows you to ingest files into a context. It is especially useful when you have hundreds or thousands of files to ingest. Any files ingested should be added to a synced context. The API supports standard file formats as well as certain SCORM file types.

​
Supported File Types

  • Documents: .pdf, .docx, .pptx, text/plain, text/html
  • Audio: .mp3
  • Video: .mp4

​
Supported SCORM Formats

  • Articulate Rise
  • Articulate Storyline
  • Intellum Evolve
  • Easy Generator
NOTE: For SCORM files, audio or text data is supported. Image data is not supported.

​
Available Operations

  • Create: Ingest new files into a context
  • Read: Look up existing files in a context
  • Update: Update existing files in a context
  • Delete: Delete existing files from a context

​
File Size Guidance

We do not impose a strict file size limit, but very large .pptx files and documents with extensive tabular data may not process correctly. Videos over 1GB may not process.

​
Resources

​
Functional APIs

The APIs below perform specific functions.

​
Agent Sessions API

The Agent Sessions API lets you assign knowledge contexts and MCPs to an agent on a per-user basis. This means different users can have different experiences while interacting with the same agent.

​
Use Case

This is useful for managing multi-tenant systems where different users have different privileges or needs. Read more about Multi-tenancy

​
Session Structure

agentUid + contextUid(s) + mcpUid(s) + userUid + tags

​
Limits per Session

  • 1 Agent only
  • Up to 30 Contexts
  • Up to 5 MCPs
  • 1 User only
  • Up to 10 tags

​
Resources

​
SDK Users API

The SDK Users API allows you to generate an authentication token for a user, which can be used to authenticate them in the Mindset SDK. This ensures a user is authenticated before they gain access to an agent. The data captured here (name, externalId, userEmail) can be used to identify users when reviewing user message data via the Agent Liveboard.

​
Resources