Sign Customiser

Navigation

Dark mode

AI sign designs

set_ai_design_feedback

destructive write

Set AI design feedback

Copy page

Tell Sign Customiser whether the merchant liked an AI design.

Overview

Record the store rating of one AI design, thumbs_up or thumbs_down, as the thumbs buttons of the merchant admin do. It replaces any earlier rating of the store, and get_ai_design reads it back as feedback_rating. It uses no credit and changes nothing else. Each connection can rate 10 designs a minute. Requires ai_sign_designs:write. An idempotency_key is optional.

Permission

Requires theai_sign_designs:writepermission. A connection without it answersinsufficient_scopenaming the permission to approve.

Annotations

readOnlyHintfalse
destructiveHinttrue
idempotentHintfalse
openWorldHintfalse

Prerequisites

  • An AI design id from list_ai_designs or get_ai_design.
  • A merchant has connected this store and approved the ai_sign_designs:write scope.

Side effects

  • Replaces the earlier rating of the store on the design.
  • Uses no credit.

Arguments

ai_design_idintegerrequired

The AI design id, from list_ai_designs.

ratingstringrequired

The rating: thumbs_up or thumbs_down.

idempotency_keystring

An optional client-generated key unique to this logical write, such as a UUID. Repeating the call with the same key and the same arguments replays the original result; the route does not require one.

Result

The rating as recorded, with when it last changed.

request_idstringalways present
storeobjectalways present
store.idintegeralways present
store.namestringalways present
feedbackobjectalways present
feedback.ai_design_idintegeralways present
feedback.ratingstringalways present

One of: thumbs_up, thumbs_down

feedback.updated_atstringalways present
idempotent_replayboolean

True when this call replayed a previously recorded response for the same idempotency_key instead of applying the write again.

Error cases

idempotency_key_conflict

The key was used with another rating. Send a new key.

insufficient_scope

The connection was approved without ai_sign_designs:write.

rate_limited

This connection rated too many designs in the last minute. Wait retry_after seconds.

resource_not_found

The id is unknown, belongs to another store, or the design was erased.

validation_failed

rating is not thumbs_up or thumbs_down; allowed_values lists them.

Rate a design thumbs up

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_ai_design_feedback",
    "arguments": {
      "ai_design_id": 51234,
      "rating": "thumbs_up"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "structuredContent": {
      "request_id": "req_01jz9x2k7c8f3m5n6p7q8r9s0t",
      "store": {
        "id": 12,
        "name": "Demo Signs"
      },
      "feedback": {
        "ai_design_id": 51234,
        "rating": "thumbs_up",
        "updated_at": "2026-10-20T09:40:00Z"
      },
      "idempotent_replay": false
    }
  }
}

A rating that does not exist (error)

tools/call
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "set_ai_design_feedback",
    "arguments": {
      "ai_design_id": 51234,
      "rating": "five_stars"
    }
  }
}
result
{
  "jsonrpc": "2.0",
  "id": 1,
  "result": {
    "isError": true,
    "structuredContent": {
      "error": {
        "code": "validation_failed",
        "title": "Validation failed",
        "detail": "The request payload failed validation. Correct the fields listed in errors and retry.",
        "recovery": "Correct every field listed in errors, using its pointer to locate the value and allowed_values where one is given, then call the tool again.",
        "pointer": "/rating",
        "allowed_values": [
          "thumbs_up",
          "thumbs_down"
        ]
      }
    }
  }
}

Type a question and press Enter. Use the arrow keys to move between the results.