Guidejar Help Centre · Acciones GPT

{
  "openapi": "3.0.0",
  "info": {
    "title": "GuidEJAR API",
    "description": "API for fetching and searching guides in markdown format.",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://us-central1-saas-demo-f016c.cloudfunctions.net"
    }
  ],
  "paths": {
    "/fetchGuide": {
      "get": {
        "summary": "Fetch Guide",
        "description": "Retrieves guide data in markdown format.",
        "operationId": "FetchGuide",
        "parameters": [
          {
            "name": "id",
            "in": "query",
            "description": "ID of the guide to fetch",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "text/markdown": {
                "schema": {
                  "type": "string"
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    },
    "/searchGuidesHTTP?helpcenterId=rgPBVgZeW6lTuLN1cJFm": {
      "get": {
        "summary": "Search Guides",
        "description": "Searches guides based on helpcenter ID and query.",
        "operationId": "SearchGuides",
        "parameters": [
          {
            "name": "helpcenterId",
            "in": "query",
            "description": "ID of the help center",
            "required": false,
            "schema": {
              "type": "string",
              "default": "rgPBVgZeW6lTuLN1cJFm"
            }
          },
          {
            "name": "query",
            "in": "query",
            "description": "Search query for the guides",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Search results found",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "createdAt": {
                        "type": "integer",
                        "format": "int64"
                      },
                      "faviconUrl": {
                        "type": "string",
                        "format": "uri"
                      },
                      "numberOfSteps": {
                        "type": "integer"
                      },
                      "description": {
                        "type": "string"
                      },
                      "id": {
                        "type": "string"
                      },
                      "title": {
                        "type": "string"
                      },
                      "order": {
                        "type": "integer"
                      }
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request"
          },
          "404": {
            "description": "Not Found"
          }
        }
      }
    }
  }
}