Queries

generatedReplies

This API is in beta and may change without notice. Returns the current suggested reply candidates for a thread, scoped to the most recent customer message. Suggestions submitted via addGeneratedReply are always included. Suggestions generated by Plain AI are excluded when suggested responses are disabled or not available for the workspace, or when an externally submitted suggestion exists for the same message. Returns an empty list if no customer message exists on the thread or no suggestion is available. Requires the generatedReply:read permission.

QUERY

generatedReplies(threadId: ID!, options: [GenerateReplyOption!]): [GeneratedReply!]

Arguments

threadId

ID!

required

options

[GenerateReplyOption!]

Returns

[GeneratedReply!]

ID!

markdown

String!

The suggested reply content in Markdown format (max 5,000 characters).

timelineEntryId

The ID of the customer timeline entry (message) this suggestion is attached to. Null for legacy suggestions created before this field was introduced.

text

String!

deprecated

Use markdown instead.

createdAt

createdBy

updatedAt

updatedBy

Query

query GeneratedReplies($threadId: ID!) {
  generatedReplies(threadId: $threadId) {
    id
    markdown
    timelineEntryId
    text
    createdAt {
      unixTimestamp
      iso8601
    }
    createdBy {
      __typename
      ... on UserActor {
        userId
        user {
          __typename
        }
      }
    }
  }
}

Variables

{
  "threadId": "id"
}

Response

{
  "data": {
    "generatedReplies": [
      {
        "id": "id",
        "markdown": "string",
        "timelineEntryId": "id",
        "text": "string",
        "createdAt": {
          "unixTimestamp": "string",
          "iso8601": "string"
        },
        "createdBy": {
          "__typename": "UserActor",
          "userId": "id",
          "user": {
            "__typename": "User"
          }
        }
      }
    ]
  }
}

⌘I