> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# API Reference & Tools Overview

> REST APIs, configuration languages, and developer resources for building on Moveworks

# API Reference & Tools

Moveworks provides REST APIs to integrate AI-powered automation into your applications and workflows. This area also covers the [configuration languages](#configuration-languages) used throughout the platform (DSL rules and Data Mappers) and the [tools and resources](#tools--resources) for building and testing plugins.

## API Categories

### Core APIs (Moveworks-hosted)

These APIs are hosted by Moveworks and allow you to send data and interact with the platform:

| API                                | Description                                                          |
| ---------------------------------- | -------------------------------------------------------------------- |
| **Events API**                     | Send events to trigger automations and workflows                     |
| **Conversations API**              | Create and manage conversation threads programmatically (`/rest/v1`) |
| **(Deprecated) Conversations API** | Deprecated `/assistant/v1` base path, superseded by `/rest/v1`       |
| **(Beta) Conversations API**       | Previous beta version (`v1beta1`)                                    |
| **Data API**                       | Query and manage data within the platform                            |
| **Webhook Listeners**              | Receive webhook events from external systems                         |

Each API has its own section in the sidebar with endpoint reference and setup guides, for example the [Conversations API](/api-reference/conversations-api/overview), [Data API](/api-reference/data-api), and [Webhook Listeners](/api-reference/webhook-listeners).

### Gateways (Customer-hosted)

These APIs are implemented by customers to provide data to Moveworks:

| Gateway               | Description                                 |
| --------------------- | ------------------------------------------- |
| **Content Gateway**   | Serve content and documents to the AI       |
| **Identity Gateway**  | Resolve user identities across systems      |
| **Knowledge Gateway** | Provide knowledge base search results       |
| **Forms Gateway**     | Handle form submissions and data collection |

## Authentication

The Moveworks-hosted Events API, Data API, and Webhook Listeners authenticate with a static API key sent as a Bearer token in the `Authorization` header. The Conversations API instead mints a per-user token through an OAuth token exchange; see the [Conversations API overview](/api-reference/conversations-api/overview). The customer-hosted gateways are authenticated in the other direction, with Moveworks calling your endpoint; see [Content Gateway authentication](/api-reference/content-gateway/authentication).

```bash
curl -X GET "https://api.moveworks.ai/rest/v1/conversations" \
  -H "Authorization: Bearer YOUR_API_KEY"
```

## Base URLs

The Moveworks API is hosted per data center. Every API request must go to the base URL for the data center your org is on. `https://api.moveworks.ai` only serves US Production. Sending requests to the wrong host fails authentication even if your token is otherwise valid, because credentials are registered per data center.

| Data Center              | Base URL                                   |
| ------------------------ | ------------------------------------------ |
| United States (default)  | `https://api.moveworks.ai`                 |
| Canada                   | `https://api.am-ca-central.moveworks.ai`   |
| EU                       | `https://api.am-eu-central.moveworks.ai`   |
| Australia / Asia Pacific | `https://api.am-ap-southeast.moveworks.ai` |
| Government Secure Cloud  | `https://api.moveworksgov.ai`              |
| Japan                    | `https://api.jp.moveworks.com`             |
| UK                       | `https://api.uk.moveworks.com`             |
| US Prod 4                | `https://api.prod4.us.moveworks.com`       |
| US Prod 3                | `https://api.prod3.us.moveworks.com`       |

> **Info**
>
> Your data center is in the hostname you use to sign in to MyMoveworks (for example, `my.am-eu-central.moveworks.com` is EU); use the matching base URL above. If your hostname isn't in the list, contact Moveworks Support for the base URL before making API calls.

## Rate Limits

API requests are rate limited to ensure platform stability. You can raise the Message API and Events API limits yourself under **Organization Details > Tenant Settings > Rate limit** (type **Moveworks Message API**); for other APIs, contact Moveworks Support.

## Configuration Languages

Two small languages appear throughout Moveworks configuration. **DSL** rules express business logic as expressions that evaluate against Moveworks data objects such as User and Ticket, or against JSON from an external system, and are used in launch rules, Setup fields, plugin configuration, and connectors. **Data Mappers** (also called Bender) transform JSON payloads, extracting, reshaping, and formatting data as it moves between systems. Test either one in the playground before applying it.

#### [DSL and Mapper Playground](/api-reference/configuration-languages/dsl-and-mapper-playground)

Evaluate a DSL expression or Data Mapper against a sample payload inside Moveworks Setup, with a visual rule builder and a searchable function reference. No API key required.

#### [Common DSL & Mapper Patterns](/api-reference/configuration-languages/common-dsl-mapper-patterns)

Recipes for the patterns that come up most in real builds, starting with how string constants work in YAML.

#### [DSL Reference](/api-reference/configuration-languages/moveworks-dsl-reference)

Operators, syntax, and precedence for DSL rules, with common examples and rule scenarios for plugins.

#### [Data Mapper Reference](/api-reference/configuration-languages/moveworks-bender-language-reference)

The operators and functions of the data mapping language, with common examples.

#### [DSL Builder & Evaluator](/api-reference/configuration-languages/dsl-builder-evaluator)

Create, modify, and test the DSL rules used across Moveworks, including context-dependent expressions that need an ingested user.

#### [Custom Attributes](/api-reference/configuration-languages/custom-attributes)

Register attributes beyond the defaults on User, Ticket, Approvals, and Knowledge, and reference them in DSL rules.

#### [Data Dictionary](/api-reference/configuration-languages/data-dictionary)

The Moveworks data objects that rules and mappers evaluate against: User, Ticket, TicketGatewayContext, Handoff, Domain, ApprovableEntity, Group, and DocSource.

## Tools & Resources

#### [AI Agent Marketplace](/api-reference/agentic-automation)

Over 100 pre-built plugins for IT, HR, sales, finance, and other functions that you can browse, install, and configure for your tenant.

#### [Developer Tools](/api-reference/developer-tools)

ToolSmith, Purple Chat, the Purple API tool, the DSL & Mapper Playground, Message Tester, and API Mocker.

#### [Moveworks on GitHub](https://github.com/moveworks)

The Moveworks organization on GitHub.

Within the Marketplace, [Installing AI Agents](/api-reference/agentic-automation/ai-agent-marketplace-installation) walks through the install flow, and [Initiative Designer](/api-reference/agentic-automation/initiative-designer) lets you discover and customize end-to-end business processes before you build. For a mock backend of enterprise systems to build and test against, follow [Purple Suite Setup](/tool-studio/quickstart-guide/purple-suite-setup).

## Also in This Area

* [Errors](/api-reference/errors)
* [Legacy & Deprecated APIs](/api-reference/legacy-deprecated-apis)
* Events API: [Chat Markup](/api-reference/events-api/chat-markup), [Rate Limits](/api-reference/events-api/rate-limits), [Message Delivery](/api-reference/events-api/message-delivery)
* Legacy Gateways: [Legacy Gateway Authentication](/api-reference/legacy-gateways/authentication), [Response Options](/api-reference/legacy-gateways/response-options), [Field Types](/api-reference/legacy-gateways/field-types), [Form Gateway Errors](/api-reference/legacy-gateways/form-gateway-errors)
* Configuration Languages: [Overview](/api-reference/configuration-languages), [Examples: String Utils](/api-reference/configuration-languages/dsl/examples-string-utils), [Mapping 2D Arrays to Lists of JSON](/api-reference/configuration-languages/mapper/mapping-2d-arrays-to-lists-of-json), [Examples: Parsing a Streamed Response](/api-reference/configuration-languages/mapper/examples-parsing-a-streamed-response), [Examples: Sending an XML Request](/api-reference/configuration-languages/mapper/examples-sending-an-xml-request)