How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Moveworks responses API

The responses API from Moveworks — 3 operation(s) for responses.

Moveworks responses API is one of 9 APIs that Moveworks publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Responses. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 67 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 6 base URLs: https://api.moveworks.ai/rest/v1beta1, https://api.jp.moveworks.com/rest/v1beta1, https://api.uk.moveworks.com/rest/v1beta1, https://api.prod4.us.moveworks.com/rest/v1beta1, https://api.prod3.us.moveworks.com/rest/v1beta1, https://api.moveworks.ai/assistant/v1.

3 operations 3 paths 67 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.moveworks.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Moveworks responses API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerAuth).

  • BearerAuth — JWT bearer token authentication. Obtain an access token from the Moveworks auth endpoint and include it in the Authorization header as 'Bearer '.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

responses 3
POST
/conversations/{conversation_id}/responses
Create response
create-response 3 params body → 202400401403404429500
POST
/conversations/{conversation_id}/responses/stream
Create response (streaming)
create-response-stream 4 params body → 200400401403404429500
GET
/conversations/{conversation_id}/responses/{response_id}
Get response
get-response 4 params → 200401403404429500

Schemas 67

The contract defines 67 schemas that model the data the API accepts and returns. The most detailed are Message_2 (10 properties), Message (9 properties), Response (6 properties), ReasoningMessage (5 properties). Each schema is shown below with its type and property counts.

ResponseCreatedData
object
Data for RESPONSECREATED event - response initially created
3 properties 3 required
CitationLocation
object
Deprecated: Use Message.contentreferences for positional data instead. This field will no longer be populated starting May 12, 2026 for both new and existing m…
1 property
CreateResponseStreamRequest
object
1 property 1 required
Response
object
6 properties 4 required
MarkdownTextContent
object
1 property 1 required
ForbiddenErrorResponseErrorCode
string
ResponseStreamData
Event data payload (structure depends on event type)
Display
object
3 properties
ResponseInProgressData
object
Data for RESPONSEINPROGRESS event - response processing update
3 properties 3 required
ResponseStreamEvent
object
A server-sent event containing response update content
2 properties 2 required
ActorType
string
Message actor type
FeedbackOption
object
1 property 1 required
Citation
object
4 properties
PlainTextContentItemType
string
Content type discriminator
ResponseFailedData
object
Data for RESPONSEFAILED event - response processing failed
3 properties 3 required
InputRequiredErrorResponse
object
Error response for missing required input field
1 property 1 required
UnauthorizedErrorResponseErrorCode
string
UnauthorizedErrorResponse
object
Error response for unauthorized access
1 property 1 required
ResponseStatus
string
Response processing status
UserInput
object
1 property 1 required
Message
object
9 properties 6 required
ConversationsConversationIdResponsesStreamPostParametersAccept
string
CitationContentReference
object
2 properties 2 required
CommonmarkTextContentItemType
string
Content type discriminator
ForbiddenErrorResponse
object
Error response for forbidden access
1 property 1 required
ReasoningMessageOutputItemType
string
Output item type discriminator
MessageFeedback
object
Feedback options available on an assistant message. When present, this message supports feedback and the callback IDs can be used to submit a rating.
2 properties
CreateResponseRequest
object
1 property 1 required
InternalErrorResponseErrorCode
string
InternalErrorResponse
object
Error response for internal server error
1 property 1 required
StreamingErrorData
object
Data for ERROR event - error that occurs mid-stream
1 property 1 required
OutputItem
Output item wrapper with type discriminator
InternalErrorResponseError
object
2 properties 2 required
UnauthorizedErrorResponseError
object
2 properties 2 required
NotFoundErrorResponse
object
Error response for resource not found
1 property 1 required
ForbiddenErrorResponseError
object
2 properties 2 required
Error
object
2 properties 2 required
Attribute
object
Key-value pair for citation display metadata. This is an opaque structure that contains rendering hints specific to each citation. Clients should not make assu…
2 properties 2 required
Content
Message content with type discriminator
MessageOutputItemType
string
Output item type discriminator
NotFoundErrorResponseError
object
2 properties 2 required
InputRequiredErrorResponseErrorCode
string
ResponseCompletedData
object
Data for RESPONSECOMPLETED event - response successfully completed
3 properties 3 required
RateLimitExceededErrorResponseErrorCode
string
InputRequiredErrorResponseError
object
2 properties 2 required
ReasoningMessage
object
5 properties 5 required
MarkdownTextContentItemType
string
Content type discriminator
StreamEventType
string
Response streaming event type
RateLimitExceededErrorResponseError
object
2 properties 2 required
NotFoundErrorResponseErrorCode
string
RateLimitExceededErrorResponse
object
Error response for rate limit exceeded
1 property 1 required
CommonmarkTextContent
object
1 property 1 required
ResponseOutputDeltaData
object
Data for RESPONSEOUTPUTDELTA event - new output item generated
3 properties 3 required
PlainTextContent
object
1 property 1 required
URLAction
object
1 property 1 required
UserInput1
object
1 property 1 required
UrlActionItemType
string
Action type discriminator
UserInput0
object
1 property 1 required
CallbackActionContent
object
1 property 1 required
Citation_2
object
3 properties
UserInput_2
User input for a response. Exactly one of text or callbackid must be provided.
Message_2
object
10 properties 6 required
CallbackActionContentItemType
string
Content type discriminator
Action
An action a user can take in response to a message. The type field determines which action payload is present.
CallbackAction
object
1 property 1 required
CallbackActionItemType
string
Action type discriminator
Content_2
Message content with type discriminator

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

moveworks-responses-api-openapi.yml Raw ↑

Other APIs Moveworks publishes across the network.

Moveworks authentication API
Moveworks conversations API
Moveworks Default API
Moveworks deprecated API
Moveworks events API
Moveworks messages API
Moveworks smartForms API
Moveworks webhooks API
Where this information came from

This is an independent, third-party profile of Moveworks responses API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.