responses

Get response

Retrieves the current state and output of a response. Only returns assistant outputs. Use Get messages in a conversation or response to retrieve the full set of messages including user messages. Clients can poll this endpoint to watch for response completion by repeatedly calling until the status reaches a terminal state (COMPLETED or FAILED). Clients can wait up to 120 seconds for a response to reach a terminal state.

get/conversations/{conversation_id}/responses/{response_id}

Request

  • Base URL: https://api.moveworks.ai/rest/v1beta1
  • URL: https://api.moveworks.ai/rest/v1beta1/conversations/{conversation_id}/responses/{response_id}
  • Auth: HTTP bearer

Path parameters

conversation_idstring required

A base-62 identifier prefixed by a short resource type

response_idstring required

A base-62 identifier prefixed by a short resource type

Headers

Assistant-Namestring required

The Moveworks assistant identifier that was configured for your organization.

Response

Response retrieved successfully

response_idstring required

A base-62 identifier prefixed by a short resource type

conversation_idstring required

A base-62 identifier prefixed by a short resource type

status'CREATED' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' required

Response processing status

created_atstring date-time required

Creation timestamp (ISO 8601)

completed_atstring date-time nullable

Completion timestamp (ISO 8601), null if not completed

Changes

No recorded changes to this operation across all 1 revision of this API.