Market Brew Ask Chat API

Conversational answers backed by crawled customer content, knowledge bases, and Ask Widget configuration.

GitHub OpenAPI

Operations 5

GET /api/v1/ask-chat/{askWidgetId}/chat Get chat session state #
POST /api/v1/ask-chat/{askWidgetId}/chat Send a chat message #
GET /api/v1/ask-chat/{askWidgetId}/conversations List conversations #
GET /api/v1/ask-chat/{askWidgetId}/conversations/{conversationId} Get conversation detail #
POST /api/v1/ask-chat/{askWidgetId}/feedback Rate an Ask Widget answer #

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-chat-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-chat-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Market Brew API Documentation Ask Chat API
  description: REST API reference for Market Brew platform data, content intelligence, and customer workspace endpoints.
  version: '1.0'
servers:
- url: /
tags:
- name: Ask Chat
  description: Conversational answers backed by crawled customer content, knowledge bases, and Ask Widget configuration.
paths:
  /api/v1/ask-chat/{askWidgetId}/chat:
    get:
      tags:
      - Ask Chat
      summary: Get chat session state
      parameters:
      - name: askWidgetId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: conversationId
        in: query
        description: Existing conversation id (optional) to resume.
        schema:
          format: int64
          type: integer
      - name: websiteHost
        in: query
        required: false
        schema:
          type: string
      - name: X-Ask-Session-Token
        in: header
        description: Server-issued browser-session credential that owns public widget conversations.
        schema:
          type: string
      responses:
        '200':
          description: Current session state including the active conversation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatSessionResponse'
      security:
      - API-Key: []
      operationId: getApiV1AskChatByAskWidgetIdChat
      x-operation-id-source: derived
    post:
      tags:
      - Ask Chat
      summary: Send a chat message
      description: Creates a new Ask conversation or continues an existing one for a configured Ask Widget.
      parameters:
      - name: askWidgetId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: websiteHost
        in: query
        required: false
        schema:
          type: string
      - name: X-Ask-Session-Token
        in: header
        description: Server-issued browser-session credential that owns public widget conversations.
        schema:
          type: string
      requestBody:
        description: Chat request payload. Omit conversationId to start a new conversation.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChatRequest'
            examples:
              Chat request:
                value:
                  websiteHost: www.example.com
                  userMessage: What are the highest-impact pages to update for AI search visibility?
        required: true
      responses:
        '200':
          description: Chat response payload
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatResponse'
              examples:
                Chat response:
                  value:
                    conversationId: 12345
                    response: Market Brew improves AI visibility by identifying content gaps and mapping them to pages, prompts, and optimization tasks.
                    html: <p>Market Brew improves AI visibility by identifying content gaps...</p>
        '402':
          description: No active license or remaining entitlements for the Ask Widget on this site
        '503':
          description: Ask Widget is inactive or has no retrievable grounded corpus
        '429':
          description: Public widget session or source IP exceeded its request rate
        '500':
          description: Internal error processing the chat request
      security:
      - API-Key: []
      operationId: postApiV1AskChatByAskWidgetIdChat
      x-operation-id-source: derived
  /api/v1/ask-chat/{askWidgetId}/conversations:
    get:
      tags:
      - Ask Chat
      summary: List conversations
      parameters:
      - name: askWidgetId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: websiteHost
        in: query
        required: false
        schema:
          type: string
      - name: X-Ask-Session-Token
        in: header
        description: Server-issued browser-session credential that owns public widget conversations.
        schema:
          type: string
      responses:
        '200':
          description: Conversation summaries
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConversationSummary'
      security:
      - API-Key: []
      operationId: getApiV1AskChatByAskWidgetIdConversations
      x-operation-id-source: derived
  /api/v1/ask-chat/{askWidgetId}/conversations/{conversationId}:
    get:
      tags:
      - Ask Chat
      summary: Get conversation detail
      parameters:
      - name: askWidgetId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: conversationId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: X-Ask-Session-Token
        in: header
        description: Server-issued browser-session credential that owns public widget conversations.
        schema:
          type: string
      responses:
        '200':
          description: Full conversation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConversationDTO'
      security:
      - API-Key: []
      operationId: getApiV1AskChatByAskWidgetIdConversationsByConversationId
      x-operation-id-source: derived
  /api/v1/ask-chat/{askWidgetId}/feedback:
    post:
      tags:
      - Ask Chat
      summary: Rate an Ask Widget answer
      parameters:
      - name: askWidgetId
        in: path
        required: true
        schema:
          format: int64
          type: integer
      - name: websiteHost
        in: query
        schema:
          type: string
      - name: X-Ask-Session-Token
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AnswerFeedbackRequest'
      responses:
        '201':
          description: Created
      security:
      - API-Key: []
      operationId: postApiV1AskChatByAskWidgetIdFeedback
      x-operation-id-source: derived
components:
  schemas:
    AnswerSource:
      type: object
      properties:
        citationNumber:
          format: int32
          type: integer
        title:
          type: string
        url:
          type: string
    AnswerFeedbackRequest:
      type: object
      properties:
        messageId:
          format: int64
          type: integer
        rating:
          type: string
    ChatResponse:
      type: object
      properties:
        conversationId:
          format: int64
          type: integer
        assistantResponse:
          type: string
        chatBoxHTML:
          type: string
        metrics:
          type: object
          additionalProperties:
            type: object
        messageId:
          format: int64
          type: integer
        sources:
          type: array
          items:
            $ref: '#/components/schemas/AnswerSource'
        followUps:
          type: array
          items:
            type: string
    ConversationDTO:
      type: object
      properties:
        conversationId:
          format: int64
          type: integer
        title:
          type: string
        createdAt:
          format: date-time
          type: string
          example: 2022-03-10 12:15:50
        messages:
          type: array
          items:
            $ref: '#/components/schemas/ChatMessage'
    ChatMessage:
      type: object
      properties:
        role:
          type: string
        content:
          type: string
        createdAt:
          format: date-time
          type: string
          example: 2022-03-10 12:15:50
        messageId:
          format: int64
          type: integer
        sources:
          type: array
          items:
            $ref: '#/components/schemas/AnswerSource'
        followUps:
          type: array
          items:
            type: string
        rating:
          type: string
    ChatSessionResponse:
      type: object
      properties:
        currentConversation:
          $ref: '#/components/schemas/ConversationSummary'
        chatHistory:
          type: array
          items:
            $ref: '#/components/schemas/ChatMessage'
    ChatRequest:
      type: object
      properties:
        websiteHost:
          type: string
        conversationId:
          format: int64
          type: integer
        userMessage:
          type: string
    ConversationSummary:
      type: object
      properties:
        conversationId:
          format: int64
          type: integer
        title:
          type: string
        createdAt:
          format: date-time
          type: string
          example: 2022-03-10 12:15:50
  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