Market Brew Ask Widget API

Chat and content-gap reporting endpoints for the MarketBrew Ask widget.

GitHub OpenAPI

Operations 6

GET /api/v1/ask-widget List Ask Widgets #
POST /api/v1/ask-widget Create an Ask Widget #
GET /api/v1/ask-widget/conversations/count Count Ask Widget conversations for the authenticated customer #
GET /api/v1/ask-widget/{id} Get an Ask Widget #
PUT /api/v1/ask-widget/{id} Update an Ask Widget #
DELETE /api/v1/ask-widget/{id} Delete an Ask Widget #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/marketbrew-ai:marketbrew-ai-ask-widget-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

marketbrew-ai-ask-widget-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Market Brew API Documentation Ask Widget API
  description: REST API reference for Market Brew platform data, content intelligence, and customer workspace endpoints.
  version: '1.0'
servers:
- url: /
tags:
- name: Ask Widget
  description: Chat and content-gap reporting endpoints for the MarketBrew Ask widget.
paths:
  /api/v1/ask-widget:
    get:
      tags:
      - Ask Widget
      summary: List Ask Widgets
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AskWidgetDTO'
      security:
      - API-Key: []
      operationId: getApiV1AskWidget
      x-operation-id-source: derived
    post:
      tags:
      - Ask Widget
      summary: Create an Ask Widget
      requestBody:
        description: Ask Widget configuration to create.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AskWidgetDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AskWidgetDTO'
      security:
      - API-Key: []
      operationId: postApiV1AskWidget
      x-operation-id-source: derived
  /api/v1/ask-widget/conversations/count:
    get:
      tags:
      - Ask Widget
      summary: Count Ask Widget conversations for the authenticated customer
      parameters:
      - name: endDate
        in: query
        description: End of date range (ISO-8601 date, e.g. 2025-02-01)
        required: false
        schema:
          type: string
      - name: startDate
        in: query
        description: Start of date range (ISO-8601 date, e.g. 2025-01-01)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Total number of conversations
          content:
            application/json:
              schema:
                format: int64
                type: integer
      security:
      - API-Key: []
      operationId: getApiV1AskWidgetConversationsCount
      x-operation-id-source: derived
  /api/v1/ask-widget/{id}:
    get:
      tags:
      - Ask Widget
      summary: Get an Ask Widget
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AskWidgetDTO'
      security:
      - API-Key: []
      operationId: getApiV1AskWidgetById
      x-operation-id-source: derived
    put:
      tags:
      - Ask Widget
      summary: Update an Ask Widget
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      requestBody:
        description: Ask Widget configuration updates.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AskWidgetDTO'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AskWidgetDTO'
      security:
      - API-Key: []
      operationId: putApiV1AskWidgetById
      x-operation-id-source: derived
    delete:
      tags:
      - Ask Widget
      summary: Delete an Ask Widget
      parameters:
      - name: id
        in: path
        required: true
        schema:
          format: int64
          type: integer
      responses:
        '204':
          description: No Content
      security:
      - API-Key: []
      operationId: deleteApiV1AskWidgetById
      x-operation-id-source: derived
components:
  schemas:
    LocalizedMessageDTO:
      type: object
      properties:
        id:
          format: int64
          type: integer
        name:
          type: string
        customer:
          $ref: '#/components/schemas/CrewSummary'
        messageLocale:
          type: object
        message:
          type: string
        translationState:
          $ref: '#/components/schemas/LocalizedMessageTranslationState'
        translations:
          type: array
          items:
            $ref: '#/components/schemas/LocalizedMessageDTO'
    ContentTemplateInfo:
      type: object
      properties:
        contentTemplateId:
          format: int64
          type: integer
        templateName:
          type: string
    WebsiteSummary:
      type: object
      properties:
        websiteId:
          format: int64
          type: integer
        serverHost:
          type: string
    LocalizedMessageTranslationState:
      enum:
      - OUT_OF_SYNC
      - NOT_TRANSLATED
      - DRAFT
      - NEEDS_REVIEW
      - APPROVED
      type: string
    AskWidgetDTO:
      type: object
      properties:
        id:
          format: int64
          type: integer
        sessionToken:
          type: string
        active:
          type: boolean
        name:
          type: string
        allowedSites:
          type: array
          items:
            $ref: '#/components/schemas/WebsiteSummary'
        systemPrompt:
          type: string
        autoLaunchpadEnabled:
          type: boolean
        autoGenEnabled:
          type: boolean
        autoGenTemplate:
          $ref: '#/components/schemas/ContentTemplateInfo'
        autoGenMinGapThreshold:
          format: double
          type: number
        retrievalMode:
          type: string
        topClusterWeight:
          format: double
          type: number
        pageAverageWeight:
          format: double
          type: number
        tfIdfWeight:
          format: double
          type: number
        uiText:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/LocalizedMessageDTO'
    CrewSummary:
      type: object
      properties:
        id:
          format: int64
          type: integer
        email:
          type: string
        businessName:
          type: string
  securitySchemes:
    API-Key:
      type: apiKey
      description: Market Brew API key. Send this value in the API-Key request header.
      name: API-Key
      in: header
    OAuth2-Bearer:
      type: http
      description: Short-lived Market Brew OAuth access token for the ChatGPT MCP resource.
      scheme: bearer
      bearerFormat: JWT