(Beta) Conversations APIResponses

Create response

View as Markdown

Creates a response object for processing. Returns immediately with the response object. Use GetResponse by response_id to poll for the complete result.

Authentication

AuthorizationBearer

JWT bearer token authentication. Obtain an access token from the Moveworks auth endpoint and include it in the Authorization header as ‘Bearer <token>’.

Path parameters

conversation_idstringRequired

A base-62 identifier prefixed by a short resource type

Headers

Assistant-NamestringRequired
The Moveworks assistant identifier that was configured for your organization.

Request

This endpoint expects an object.
inputobjectRequired
User input message

Response headers

x-moveworks-root-uuidstring
A unique identifier used to trace your request within the Moveworks system

Response

Response accepted for processing (acknowledgement)

response_idstring

A base-62 identifier prefixed by a short resource type

conversation_idstring

A base-62 identifier prefixed by a short resource type

statusenum
Response processing status
Allowed values:
created_atdatetime

Creation timestamp (ISO 8601)

completed_atdatetime or null

Completion timestamp (ISO 8601), null if not completed

outputslist of objects
Output items

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error