Cite GPT · Actions GPT

{
  "openapi": "3.1.0",
  "info": {
    "title": "Super Cool App’s API",
    "description": "API that allows you to communicate with the Super Cool App, including Reddit search functionality and GPT-3 model integration.",
    "version": "v1.0.1"
  },
  "servers": [
    {
      "url": "https://medimind-559774263625.us-central1.run.app"
    }
  ],
  "paths": {
    "/generate_citations": {
      "post": {
        "summary": "Generate Citations",
        "description": "Fetch and rank articles based on the user's query, returning the top results with citation snippets.",
        "operationId": "generateCitations",
        "requestBody": {
          "description": "User query for citation search",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/CitationRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "A list of ranked articles with best sentences.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GenerateCitationsResponse"
                }
              }
            }
          },
          "404": {
            "description": "No articles found.",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "detail": {
                      "type": "string",
                      "example": "No articles found."
                    }
                  }
                }
              }
            }
          },
          "500": {
            "description": "Server error",
            "content": {
              "application/json": {
                "schema": {
                  "type": "string",
                  "example": "Server encountered an error."
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "CitationRequest": {
        "type": "object",
        "properties": {
          "text": {
            "type": "string",
            "description": "The query text to search for citations.",
            "example": "The benefits of vitamin D on immune function"
          }
        },
        "required": [
          "text"
        ]
      },
      "GenerateCitationsResponse": {
        "type": "object",
        "properties": {
          "articles": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "title": {
                  "type": "string",
                  "description": "The title of the article.",
                  "example": "Vitamin D and Immune Function"
                },
                "url": {
                  "type": "string",
                  "description": "The URL of the article.",
                  "example": "https://pubmed.ncbi.nlm.nih.gov/12345678/"
                },
                "authors": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "List of authors for the article.",
                  "example": [
                    "John Doe",
                    "Jane Smith"
                  ]
                },
                "year": {
                  "type": "integer",
                  "description": "The year the article was published.",
                  "example": 2020
                },
                "journal": {
                  "type": "string",
                  "description": "The journal the article was published in.",
                  "example": "Journal of Nutrition"
                },
                "is_high_quality_source": {
                  "type": "boolean",
                  "description": "Indicates if the article is from a high-quality source."
                },
                "best_sentence": {
                  "type": "string",
                  "description": "The best sentence or snippet from the article related to the query.",
                  "example": "Vitamin D has been shown to enhance immune responses by promoting the production of anti-inflammatory cytokines."
                }
              }
            }
          }
        }
      }
    },
    "securitySchemes": {
      "BearerAuth": {
        "type": "http",
        "scheme": "bearer",
        "bearerFormat": "JWT",
        "description": "JWT Bearer token for authentication"
      }
    }
  }
}