For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
JWT bearer token authentication. Include the Configuration API key in the Authorization header as ‘Bearer <token>’.
Path parameters
idstringRequiredformat: "uuid"
The id of the productivity assistant, as returned when it was created or listed.
Response headers
x-trace-idstringOptional
A unique identifier used to trace your request within the Moveworks system
Response
The productivity assistant
idstringRead-onlyformat: "uuid"
Unique identifier of the assistant, assigned by the server.
namestring1-128 characters
Display name of the assistant. Must be unique in your organization.
versionobject
The version of a stored document.
descriptionstringOptional<=1024 characters
What the assistant does. Shown to users when they choose an assistant.
welcome_messagestringOptional<=1024 characters
Message shown when a user opens the assistant.
iconstringOptional<=2048 characters
Name of the assistant’s icon in the Moveworks icon set, for example MWIconPublic. This is a name, not a URL.
instructionsstringOptional<=30000 characters
Instructions that shape the assistant's behavior.
conversation_starterslist of objectsOptional
Suggested prompts shown in a new conversation. Up to 10.
plugin_identifierslist of stringsOptional
Plugins the assistant can use. Each value is a built-in plugin name such as enterprise_search_plugin, or the id of a custom plugin. An empty list means no plugins.
While knowledge_scope has at least one entry, the API keeps enterprise_search_plugin in this list for you.
knowledge_scopeobjectOptional
Limits the assistant's enterprise search to the systems, documents, workspaces and channels you list. The assistant searches the combined set. Leave the scope out, or send every list empty, to search everything the user can already access.
skill_access_modeenumOptional
Which Skills the assistant can use.
ALL - every Skill in your organization, including Skills registered later.
SELECTED - only the Skills in skill_ids.
If you leave this out when you create an assistant, the API stores SELECTED, so the assistant gets no Skills you didn’t list. On update, leaving it out keeps the stored mode.
Allowed values:
skill_idslist of stringsOptional
Ids of the Skills the assistant can use when skill_access_mode is SELECTED. Each id must belong to a Skill registered in your organization.
mcp_server_idslist of stringsOptional
Ids of the MCP servers whose tools the assistant can call. Each server must already be connected for your organization.
a2a_agent_idslist of stringsOptional
Ids of the A2A agents the assistant can delegate to. Each agent must already be registered for your organization.
user_accessobjectOptional
Who can use the assistant. Send exactly one option. Required on create, because every assistant needs an audience. On update, leave it out to keep the stored audience. The person who created the assistant always keeps access.
