v1

latestOpenAPI 3.0.02026-07-174565114.3 KB
v1

List suggestions for a message

List suggestions that have been generated for a specific message. Supports cursor-based pagination.

get/v1/threads/{threadId}/messages/{messageId}/suggestions

Path parameters

threadIdstring required
Example:thr_abc123xyz

Thread ID

messageIdstring required
Example:msg_xyz789abc

Message ID

Query parameters

limitnumber

Maximum number of suggestions to return

cursorstring

Cursor for pagination

userKeystring

Optional user key for thread organization

Response

List of suggestions

nextCursorstring

Cursor for the next page of results

hasMoreboolean required

Whether there are more results

Example response

{
  "suggestions": [
    {
      "id": "sug_123456789",
      "messageId": "msg_123456789",
      "title": "Add error handling",
      "detailedSuggestion": "Add try-catch block to handle potential API errors",
      "description": "Add try-catch block to handle potential API errors",
      "metadata": {
        "category": "error-handling",
        "priority": "high"
      }
    }
  ]
}