Yapper API
Api reference
GET
/sessions/{sessionId}/messages

Lists the conversation between the team's members and the in-app Yapper agent in this session, newest first, so an integration can pick up where it left off. Each message carries its text, the asset ids of its attachments, and the name and outcome of each step the agent took or decision a member made. The agent's reasoning and its tool inputs and outputs are never returned; use GET /processes with sessionId for what was generated. A page can hold fewer than limit messages, because turns the chat does not show are skipped. A session with no conversation returns an empty list. Read-only and free. Uses the processes:read scope.

Authorization

bearerAuth processes:read
AuthorizationBearer <token>

In: header

Scope: processes:read

Path Parameters

sessionId*string

Query Parameters

limit?integer
Range1 <= value <= 100
Default20
cursor?string

Opaque pagination cursor — pass the nextCursor from the previous page verbatim. nextCursor is null on the last page.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/sessions/string/messages"
{  "data": [    {      "id": "string",      "role": "user",      "createdAt": "2019-08-24T14:15:22Z",      "text": "string",      "textTruncated": true,      "attachments": [        {          "name": "string",          "mediaType": "string",          "assetId": "string"        }      ],      "actions": [        {          "name": "string",          "status": "completed"        }      ]    }  ],  "nextCursor": "string"}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}
{  "error": {    "code": "string",    "message": "string",    "requestId": "string"  }}