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

# API Reference

## Docs

- [API Reference Overview](https://docs.moveworks.com/api-reference/overview.md): REST APIs for integrating with Moveworks
- [API Credentials](https://docs.moveworks.com/api-reference/api-credentials.md): How to create, manage, and rotate API credentials for the Moveworks API
- [Errors](https://docs.moveworks.com/api-reference/errors.md): Standard error response format for the Moveworks REST API
- [Legacy & Deprecated APIs](https://docs.moveworks.com/api-reference/legacy-deprecated-ap-is.md): Moveworks API lifecycle stages, from stable through legacy and deprecated
- [Chat Markup](https://docs.moveworks.com/api-reference/events-api/chat-markup.md): Rich text markup reference for Moveworks chat messages
- [Rate Limits](https://docs.moveworks.com/api-reference/events-api/rate-limits.md): API rate limits for the Moveworks Events API and webhook listeners
- [Message Delivery](https://docs.moveworks.com/api-reference/events-api/message-delivery.md): How Moveworks delivers messages via the Events API
- [Conversations API overview](https://docs.moveworks.com/api-reference/conversations-api/overview.md): The Moveworks Conversations API lets your application create conversations with the assistant, send messages on behalf of your users, and receive responses over polling or streaming.
- [Create the Conversations API chatbot](https://docs.moveworks.com/api-reference/conversations-api/create-the-chatbot.md): Create the chatbot entry that represents your Conversations API integration and produces the Bot Name you send in the Assistant-Name header.
- [Set up authentication with Okta](https://docs.moveworks.com/api-reference/conversations-api/set-up-authentication-with-okta.md): Configure Okta to authenticate against the Moveworks Conversations API using a JWT OAuth credential.
- [Set up authentication with Azure AD (Entra ID)](https://docs.moveworks.com/api-reference/conversations-api/set-up-authentication-with-azure-ad-entra-id.md): Configure Azure AD (Entra ID) to authenticate against the Moveworks Conversations API, using Issuer + Audience and the oid claim for identity resolution.
- [Set up service-to-service authentication](https://docs.moveworks.com/api-reference/conversations-api/set-up-service-to-service-authentication.md): Authenticate a backend service to the Moveworks Conversations API using a self-signed JWT bearer, letting your service make requests on behalf of any provisioned user.
- [Proactive notifications overview](https://docs.moveworks.com/api-reference/conversations-api/proactive-notifications/overview.md): Understand how system-initiated messages are delivered to Conversations API integrations: architecture, routing behavior, and current limitations.
- [Receive proactive notifications via polling](https://docs.moveworks.com/api-reference/conversations-api/proactive-notifications/receive-via-polling.md): Retrieve system-initiated messages by polling the Conversations API events endpoint with a per-user checkpoint.
- [Receive proactive notifications via outbound webhook](https://docs.moveworks.com/api-reference/conversations-api/proactive-notifications/receive-via-outbound-webhook.md): Receive push notifications from Moveworks when a new system-initiated message is available, and reconcile content via the events endpoint.
- [Content Gateway](https://docs.moveworks.com/api-reference/content-gateway/overview.md): Build a customer-hosted API that serves files, users, groups, and permissions to Moveworks for ingestion and search.
- [Integration Strategies](https://docs.moveworks.com/api-reference/content-gateway/integration-strategies.md): 
- [Starter Code](https://docs.moveworks.com/ai-assistant/enterprise-search/starter-code.md): A ready-to-run Flask server for building a Moveworks Content Gateway
- [Verifying Your Build](https://docs.moveworks.com/api-reference/content-gateway/verifying-your-build.md): Validate that your Content Gateway server conforms to the Moveworks API schema before connecting to Moveworks
- [Connecting Your Gateway to Moveworks](https://docs.moveworks.com/api-reference/content-gateway/connecting-your-gateway-to-moveworks.md): Configure Moveworks to connect to and ingest content from your Content Gateway
- [Content Gateway Authentication](https://docs.moveworks.com/api-reference/content-gateway/authentication.md): Supported authentication methods for the Moveworks Content Gateway
- [How Permissions Work](https://docs.moveworks.com/api-reference/content-gateway/how-permissions-work.md): The Relationship-Based Access Control (ReBAC) model Moveworks uses to evaluate file access from your Content Gateway
- [Common Pitfalls](https://docs.moveworks.com/api-reference/content-gateway/common-pitfalls.md): The most frequent mistakes partners make when building a Moveworks Content Gateway integration
- [Operational Guide](https://docs.moveworks.com/api-reference/content-gateway/operational-guide.md): Sync pattern, capacity planning, rate limits, file size, and other operational details for running a Moveworks Content Gateway in production
- [Content Gateway Errors](https://docs.moveworks.com/api-reference/content-gateway/errors.md): Standard error codes and format for the Moveworks Content Gateway
- [Supported MIME Types](https://docs.moveworks.com/api-reference/content-gateway/supported-mime-types.md): File types supported for ingestion through the Moveworks Content Gateway
- [Legacy Gateway Authentication](https://docs.moveworks.com/api-reference/legacy-gateways/authentication.md): JWT Bearer Token authentication for Moveworks Legacy Gateways
- [Identity Gateway Response Options](https://docs.moveworks.com/api-reference/legacy-gateways/response-options.md): Optional fields, response structure, and pagination for the Identity Gateway
- [Form Field Types](https://docs.moveworks.com/api-reference/legacy-gateways/field-types.md): Supported field types for the Moveworks Forms Gateway
- [Form Gateway Errors](https://docs.moveworks.com/api-reference/legacy-gateways/form-gateway-errors.md): Additional error codes specific to the Moveworks Forms Gateway

## API Docs

- Events API > Events [Send a message for an event](https://docs.moveworks.com/api-reference/events-api/events-api/events/send-message-for-event.md)
- Events API > Authentication [Create an OAuth token](https://docs.moveworks.com/api-reference/events-api/events-api/authentication/create-o-auth-token.md)
- Events API > Authentication [Test API Key](https://docs.moveworks.com/api-reference/events-api/events-api/authentication/test-auth.md)
- Events API > Deprecated [[Deprecated] Send a message](https://docs.moveworks.com/api-reference/events-api/events-api/deprecated/send-message.md)
- Conversations API > Conversations [List conversations](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/conversations/list-conversations.md)
- Conversations API > Conversations [Create conversation](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/conversations/create-conversation.md)
- Conversations API > Conversations [Get conversation](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/conversations/get-conversation.md)
- Conversations API > Conversations [Update conversation](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/conversations/update-conversation.md)
- Conversations API > Conversations [List conversation events](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/conversations/list-events.md)
- Conversations API > Conversations [Get conversation event](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/conversations/get-event.md)
- Conversations API > Responses [Create response](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/responses/create-response.md)
- Conversations API > Responses [Create response (streaming)](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/responses/create-response-stream.md)
- Conversations API > Responses [Get response](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/responses/get-response.md)
- Conversations API > Messages [List conversation messages](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/messages/list-conversation-messages.md)
- Conversations API > Messages [List response messages](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/messages/list-response-messages.md)
- Conversations API > Messages [Submit feedback](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/messages/submit-feedback.md)
- Conversations API > Modals [Get modal](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/modals/get-modal.md)
- Conversations API > Modals [Refresh modal](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/modals/refresh-modal.md)
- Conversations API > Modals [Submit modal](https://docs.moveworks.com/api-reference/conversations-api/conversations-api/modals/submit-modal.md)
- (Deprecated) Conversations API > Conversations [List conversations](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/conversations/list-conversations.md)
- (Deprecated) Conversations API > Conversations [Create conversation](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/conversations/create-conversation.md)
- (Deprecated) Conversations API > Conversations [Get conversation](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/conversations/get-conversation.md)
- (Deprecated) Conversations API > Conversations [Update conversation](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/conversations/update-conversation.md)
- (Deprecated) Conversations API > Conversations [List conversation events](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/conversations/list-events.md)
- (Deprecated) Conversations API > Responses [Create response](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/responses/create-response.md)
- (Deprecated) Conversations API > Responses [Create response (streaming)](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/responses/create-response-stream.md)
- (Deprecated) Conversations API > Responses [Get response](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/responses/get-response.md)
- (Deprecated) Conversations API > Messages [List conversation messages](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/messages/list-conversation-messages.md)
- (Deprecated) Conversations API > Messages [List response messages](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/messages/list-response-messages.md)
- (Deprecated) Conversations API > Messages [Submit feedback](https://docs.moveworks.com/api-reference/conversations-api/deprecated-conversations-api/messages/submit-feedback.md)
- (Beta) Conversations API > Conversations [List conversations](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/conversations/list-conversations.md)
- (Beta) Conversations API > Conversations [Create conversation](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/conversations/create-conversation.md)
- (Beta) Conversations API > Conversations [Get conversation](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/conversations/get-conversation.md)
- (Beta) Conversations API > Conversations [Update conversation](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/conversations/update-conversation.md)
- (Beta) Conversations API > Conversations [List conversation events](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/conversations/list-events.md)
- (Beta) Conversations API > Responses [Create response](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/responses/create-response.md)
- (Beta) Conversations API > Responses [Create response (streaming)](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/responses/create-response-stream.md)
- (Beta) Conversations API > Responses [Get response](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/responses/get-response.md)
- (Beta) Conversations API > Messages [List conversation messages](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/messages/list-conversation-messages.md)
- (Beta) Conversations API > Messages [List response messages](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/messages/list-response-messages.md)
- (Beta) Conversations API > Messages [Submit feedback](https://docs.moveworks.com/api-reference/conversations-api/beta-conversations-api/messages/submit-feedback.md)
- (Alpha) Files API > Files [Upload file](https://docs.moveworks.com/api-reference/alpha-files-api/files/upload-file.md)
- Data API [List conversations](https://docs.moveworks.com/api-reference/data-api/list-conversations.md)
- Data API [List interactions](https://docs.moveworks.com/api-reference/data-api/list-interactions.md)
- Data API [List plugins calls](https://docs.moveworks.com/api-reference/data-api/list-plugins-calls.md)
- Data API [List Plugin Resources](https://docs.moveworks.com/api-reference/data-api/list-plugin-resources.md)
- Data API [List Users](https://docs.moveworks.com/api-reference/data-api/list-users.md)
- Webhook Listeners > Webhooks [Send a webhook to a webhook listener](https://docs.moveworks.com/api-reference/webhook-listeners/webhooks/send-a-webhook-to-a-webhook-listener.md)
- Content Gateway [List files](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/list-files.md)
- Content Gateway [Get file metadata and HTML content body](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/get-file-metadata-and-html-content-body.md)
- Content Gateway [Download file](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/download-file.md)
- Content Gateway [List users](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/list-users.md)
- Content Gateway [List groups](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/list-groups.md)
- Content Gateway [List group members](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/list-group-members.md)
- Content Gateway [Get permission model metadata](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/get-permission-model-metadata.md)
- Content Gateway [Get content permissions](https://docs.moveworks.com/api-reference/content-gateway/content-gateway/get-content-permissions.md)
- Identity Gateway [List Users](https://docs.moveworks.com/api-reference/legacy-gateways/identity-gateway/list-users.md)
- Identity Gateway [Get User By ID](https://docs.moveworks.com/api-reference/legacy-gateways/identity-gateway/get-user-by-id.md)
- Knowledge Gateway [List Articles](https://docs.moveworks.com/api-reference/legacy-gateways/knowledge-gateway/list-articles.md)
- Forms Gateway > Smart Forms [List Forms](https://docs.moveworks.com/api-reference/legacy-gateways/forms-gateway/smart-forms/list-forms.md)
- Forms Gateway > Smart Forms [Get Form By ID](https://docs.moveworks.com/api-reference/legacy-gateways/forms-gateway/smart-forms/get-form-by-id.md)
- Forms Gateway > Smart Forms [Submit a Form](https://docs.moveworks.com/api-reference/legacy-gateways/forms-gateway/smart-forms/submit-form.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.moveworks.com/api-reference/openapi.json)
- [OpenAPI YAML](https://docs.moveworks.com/api-reference/openapi.yaml)