Get response

import requests
url = "https://api.moveworks.ai/rest/v1beta1/conversations/conv_01ARZ3NDEKTSV4RRFFQ69G5FAV/responses/resp_01ARZ3NDEKTSV4RRFFQ69G5FAV"
headers = {
    "Assistant-Name": "acmecorp-conversations-rest-api",
    "Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.json())

{
  "response_id": "resp_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "conversation_id": "conv_01ARZ3NDEKTSV4RRFFQ69G5FAV",
  "status": "COMPLETED",
  "created_at": "2025-01-20T10:00:00Z",
  "updated_at": "2025-01-20T10:00:15Z",
  "outputs": [
    {
      "type": "MESSAGE",
      "message": {
        "message_id": "msg_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "conversation_id": "conv_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "response_id": "resp_01ARZ3NDEKTSV4RRFFQ69G5FAV",
        "actor": "ASSISTANT",
        "content": {
          "commonmark_text": {
            "text": "John Doe reports to Jane Smith in the Engineering department.",
            "fallback_text": "John Doe reports to Jane Smith in the Engineering department."
          }
        },
        "citations": [
          {
            "id": "user_123",
            "type": "person",
            "mention": "John Doe",
            "location": {
              "start": 0,
              "end": 8
            },
            "url": "https://workday.com/users/123"
          }
        ],
        "created_at": "2025-01-20T10:00:01Z"
      }
    }
  ],
  "completed_at": "2025-01-20T10:00:15Z",
  "error": {
    "code": "INVALID_INPUT",
    "message": "Title exceeds maximum length of 256 characters"
  }
}

Retrieves the current state and output of a response. Poll this endpoint after creating a response to get 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_idstringRequiredformat: "^conv_[0-9A-HJKMNP-TV-Z]{26}$"

Unique conversation identifier (format: conv_<ulid>)

response_idstringRequiredformat: "^resp_[0-9A-HJKMNP-TV-Z]{26}$"

Unique response identifier (format: resp_<ulid>)

Response

Response retrieved successfully

response_idstring

Unique response identifier (format: resp_<ulid>)

conversation_idstring

Parent conversation identifier

statusenum

Response processing status

Allowed values:

created_atdatetime

Creation timestamp (ISO 8601)

updated_atdatetime

Last update timestamp (ISO 8601)

outputslist of objects

Output items

completed_atdatetime or null

Completion timestamp (ISO 8601), null if not completed

errorobject or null

Error details (only present if status is FAILED)

Authentication

Path parameters

Headers

Response

Errors