Draft a response with AI

Have AI write a reply to a review, in a tone you choose. The draft is saved but not posted. Use this to give a business owner a starting point, or to respond at scale. Review the draft, edit it if you like, then post it with Post or edit a response. The review's text and rating are read automatically. Returns the draft text and its ai_review_response_id, plus how many AI drafts you have left this period. Each draft counts against your plan's AI allowance: on a hard-stop plan you get a 403 once it's used up; on an overage plan the draft is billed at your overage rate.

Prerequisites: a bearer token, the location's id (store_id) and the id of one of its reviews (review_id). AI responses must be on the location's plan.

Authentication: Partner or Account token. store_id and review_id must be inside your own account tree, and the review must belong to that location (a Partner token reaches any location under the partner, an Account token only its own); otherwise 422.

Rate limit: 60 requests per minute, counted per user (the token’s user).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required
Defaults to 3007

The location the review belongs to. Must exist and be inside your account tree.

integer
required
Defaults to 279309

The review to draft a reply for. Must exist, be inside your account tree and belong to store_id.

string
enum
Defaults to professional

The tone of the draft. Defaults to professional.

Allowed:
string | null
Defaults to Short and friendly

A short style hint. At most 500 characters.

string | null
Defaults to Mention our support team

Instructions for the draft. At most 1,000 characters.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json