Lists the team's sessions, the workspaces that group generations in the Yapper web app, newest first. Pass query to search titles over the most recent sessions instead; search returns a single page. A newly created session appears in this list within a few seconds; GET /sessions/{sessionId} reads it immediately. Uses the processes:read scope.
Authorization
bearerAuth processes:readIn: header
Scope: processes:read
Query Parameters
Words to match against session titles.
length <= 2001 <= value <= 10020Opaque 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
curl -X GET "https://example.com/sessions"{ "data": [ { "id": "string", "title": "string", "imageUrl": "http://example.com", "imageAssetId": "string", "generations": { "inProgress": 0, "completed": 0 }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "webUrl": "http://example.com", "links": { "self": "string" } } ], "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" }}Read a session's agent conversation GET
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.
List sessions by spend GET
Sessions with their all-time credit spend, runs and top model. Matches the Sessions card on the account usage page. sort is spend (default, by gross credits spent), runs, or newest. Any key may read session totals. memberId returns only that member's sessions and their share; another member's requires the key's member to be a team owner or admin, and only those keys receive contributors. A deleted session keeps its spend and is returned with deleted: true. Returns usage_breakdown_unavailable (409) until the workspace's usage history has been indexed.