Get response | Moveworks

curl https://api.moveworks.ai/rest/v1beta1/conversations/conv_32bt7BMLhLyVzTUjfi35N/responses/resp_32bt7rXXugeJjvE3pQzOk \
     -H "Assistant-Name: acmecorp-conversations-rest-api" \
     -H "Authorization: Bearer <token>"

{
  "response_id": "resp_32bt7rXXugeJjvE3pQzOk",
  "conversation_id": "conv_32bt7BMLhLyVzTUjfi35N",
  "status": "COMPLETED",
  "created_at": "2025-01-20T10:00:00Z",
  "completed_at": "2025-01-20T10:00:15Z",
  "outputs": [
    {
      "type": "REASONING_MESSAGE",
      "reasoning_message": {
        "reasoning_message_id": "rs_32bt8IqHzbv0FLmtGssa3",
        "conversation_id": "conv_32bt7BMLhLyVzTUjfi35N",
        "response_id": "resp_32bt7rXXugeJjvE3pQzOk",
        "content": {
          "type": "COMMONMARK_TEXT",
          "commonmark_text": {
            "text": "Looking up John Doe..."
          }
        },
        "created_at": "2025-01-20T10:00:01Z"
      }
    },
    {
      "type": "MESSAGE",
      "message": {
        "message_id": "msg_32bt8vagXAoRwRLIdI2Oj",
        "conversation_id": "conv_32bt7BMLhLyVzTUjfi35N",
        "response_id": "resp_32bt7rXXugeJjvE3pQzOk",
        "actor": "ASSISTANT",
        "content": {
          "type": "COMMONMARK_TEXT",
          "commonmark_text": {
            "text": "John Doe reports to Jane Smith in the Engineering department."
          }
        },
        "created_at": "2025-01-20T10:00:01Z",
        "citations": [
          {
            "location": {
              "offset": 8
            },
            "url": "https://company.com/users/123",
            "display": {
              "title": {
                "type": "COMMONMARK_TEXT",
                "commonmark_text": {
                  "text": "<https://company.com/users/123|John Doe>"
                }
              },
              "body": {
                "type": "COMMONMARK_TEXT",
                "commonmark_text": {
                  "text": "John Doe reports to Jane Smith in the Engineering department."
                }
              },
              "attributes": [
                {
                  "key": "EMAIL",
                  "value": "johndoe@company.com"
                },
                {
                  "key": "MANAGER",
                  "value": "Jane Smith"
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

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.

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.

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

response_idstringRequired

A base-62 identifier prefixed by a short resource type

Response headers

x-moveworks-root-uuidstring

A unique identifier used to trace your request within the Moveworks system

Response

Response retrieved successfully

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

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

Authentication

Path parameters

Headers

Response headers

Response

Errors