BrewshopGPT · Actions GPT

{
  "openapi": "3.0.0",
  "info": {
    "title": "GPT content and product retrieval API",
    "description": "An API that retrieves relevant documents for a given query.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://gpt-plugin-api-f580f0e41341.herokuapp.com"
    }
  ],
  "paths": {
    "/brewshop_retrieve": {
      "post": {
        "operationId": "brewshop_post_retrieve",
        "summary": "Retrieve documents about brewing products from Brewshop.no",
        "description": "Retrieves documents relevant to the given query.",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "query": {
                    "type": "string",
                    "description": "The query string to retrieve relevant documents for."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of relevant documents",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "page_content": {
                        "type": "string"
                      },
                      "metadata": {
                        "type": "object",
                        "properties": {
                          "updated": {
                            "type": "string"
                          },
                          "url": {
                            "type": "string"
                          },
                          "domain": {
                            "type": "string"
                          },
                          "category": {
                            "type": "string"
                          },
                          "subcategory": {
                            "type": "string"
                          },
                          "subcategory2": {
                            "type": "string"
                          },
                          "subcategory3": {
                            "type": "string"
                          },
                          "subcategory4": {
                            "type": "string"
                          },
                          "product": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          }
        }
      }
    },
    "/.well-known/ai-plugin.json": {
      "get": {
        "operationId": "getPluginManifest",
        "summary": "Get plugin manifest",
        "description": "Returns the plugin manifest file.",
        "responses": {
          "200": {
            "description": "Plugin manifest",
            "content": {
              "text/json": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          }
        }
      }
    },
    "/openapi.yaml": {
      "get": {
        "operationId": "getOpenAPI",
        "summary": "OpenAPI Specification",
        "description": "Returns the OpenAPI specification for this API.",
        "responses": {
          "200": {
            "description": "OpenAPI specification in YAML format",
            "content": {
              "text/yaml": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad request"
          }
        }
      }
    }
  }
}