Skip to content
Navigation

Reads one of a product's MCP prompts.

GET
https://api.sherpo.io/merchant/v1/stores/{store}/products/{product}/prompts/{prompt}

Authorization

  • bearer
    HTTP
    required

Path parameters

  • store
    string
    required

    The store's id.

  • product
    string
    required

    An id, or slug:<slug>.

    minLength: 1
  • prompt
    string
    required
    minLength: 1

Returns

200

Reads one of a product's MCP prompts.

JSON
  • id
    string
    required
  • product_id
    string
    required
  • name
    string
    required
  • title
    required

    One of the following:

    • string
    • null
  • description
    required

    One of the following:

    • string
    • null
  • body
    string
    required
  • arguments
    array of
    object
    required
    • name
      string
      required
    • description
      required

      One of the following:

      • string
      • null
    • required
      boolean
      required
    • default
      required

      One of the following:

      • string
      • null
    • match
      required

      Pattern the whole value must match, diacritic-insensitive.

      One of the following:

      • string
      • null
    • flags
      required

      Flags among i, s and u the pattern runs with; null for i alone.

      One of the following:

      • string
      • null
    • message
      required

      What a refused value is told instead of the default reason.

      One of the following:

      • string
      • null
    • lenient
      boolean
      required
  • access
    required

    One of the following:

    • object
    • null
  • position
    number
    required
  • created_at
    required

    One of the following:

    • string
    • null
JSON
  • type
    string
    required
    format: uri
  • title
    string
    required
  • status
    integer
    required
  • detail
    string
    required
  • code
    optional
    string
  • context
    optional
    object
  • reached_core
    optional
    boolean
  • core_answer
    optional
    string

Type to search…

↑↓ navigate↵ selectEsc close