Configuration API (Alpha)
The Configuration API is in alpha (v1alpha1). It’s available only to a limited set of organizations, for setup work done with Moveworks. Don’t build integrations against it: paths, fields and behavior can change or be removed without notice.
What is the Configuration API
The Moveworks Configuration API lets developers programmatically manage the configuration that powers an organization’s Moveworks Assistant — the same things an admin configures in the Setup UI today — over a plain RESTful JSON/HTTPS interface. Every write goes through the same validation the Setup UI applies (permissions, mandatory fields, allowed values, DSL/Bender syntax).
What you can manage — 57 entities, grouped into three areas that mirror the URL structure:
- Platform (
/platform/...) — tenant-wide setup: connectors, identity (assistant account, service accounts, ingestion), SSO, domains, custom attributes, tenant settings, rate limits, and the Tool Studio entities under/platform/extensions/...(HTTP connectors, actions, data types, conversational processes, plugins, webhook listeners, MCP servers) - Tools (
/tool/...) — the out-of-the-box skills: ticketing, search content & forms, software/account/group access, approvals, live agent & handoff, plugin settings - Assistant (
/assistant/...) — how the assistant shows up: display strings, surfaces, employee slate, languages, channel resolvers, embedded assistant, access rule, productivity assistants and their skills
What you can do:
- Create, update and fetch any of these configurations (
POST/PATCH/GET). The onlyDELETEin this version is for SSO connections. - Authenticate with an API key or OAuth 2.0 client created on the HTTP Connectors > Credentials page. The credential identifies your organization. See Getting started.
- Typical uses during the alpha: setting up an organization with Moveworks, copying configuration between environments, and checking a setup programmatically.
How to identify the API URL
Every request URL is built the same way:
https://api.moveworks.ai (host) + /configurations (the Configuration API) + /v1alpha1 (version) + /<area>/<entity path> (the entity)
- Base URL:
https://api.moveworks.ai/configurations/v1alpha1— everything in this reference is relative to it. - Area prefix: the first path segment tells you which area the entity belongs to —
/platform/...,/tool/...or/assistant/...(e.g./platform/connectors,/tool/ticket/routing,/assistant/display). - Collections vs settings: collection entities (things you can have many of, like connectors) support
GET(list),GET /{id}(read one),POST(create) andPATCH(update). Settings entities (one per org, like ticket routing) support onlyGETandPATCH— they already exist for your org. - No org in the URL: your API key identifies the organization — you never put an org name or tenant id in the path.
- Finding the right endpoint: every entity has its own section in the sidebar, grouped by area. Its Overview page lists the fields, and each endpoint page shows the exact path, the request and response schema, and an example.
Example — read one connector:
What is in this reference
Every entity, its endpoints, field-by-field tables with required inputs, and example request and response bodies, generated from the API contract. Start with Conventions & Getting Started.