v1Resources/Reviews/postGenerate an AI review reply draft

Generate an AI review reply draft

Generate reply text for one stored review without saving or publishing it. The review must be accessible to the key and its creator. Completed model calls consume credits even if the resulting draft is rejected as unusable. Save or publish the returned text through a separate request to POST /api/v1/reviews/reply.

post/api/v1/reviews/ai-draft
reviews:write
Request body
reviewIdstringrequired
ID of the stored review to draft a reply for.
Response
dataobjectrequired
reviewIdstringrequired
draftstringrequired
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Follow the retry guidance for this operation.
post/api/v1/reviews/ai-draft
Your API key
Request body*
{}

Guides that use this resource