AMBOSS Medical Info · GPT-Aktionen

{
  "openapi": "3.1.0",
  "info": {
    "title": "AMBOSS Retrieval API",
    "description": "An API that provides context-specific, reliable medical information sourced from the AMBOSS library.",
    "version": "v0.0.1"
  },
  "servers": [
    {
      "url": "https://chatgpt.amboss.com"
    }
  ],
  "paths": {
    "/retrieve/{language}": {
      "get": {
        "summary": "Retrieve",
        "description": "Retrieve medical information for the given query from the AMBOSS library.",
        "operationId": "retrieve_retrieve__language__get",
        "parameters": [
          {
            "name": "language",
            "in": "path",
            "required": true,
            "schema": {
              "$ref": "#/components/schemas/Language"
            }
          },
          {
            "name": "query",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string",
              "description": "The medical search query.",
              "title": "Query"
            },
            "description": "The medical search query."
          }
        ],
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Results"
                }
              }
            }
          },
          "400": {
            "description": "Invalid query parameter",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "401": {
            "description": "User is not authenticated",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "422": {
            "description": "Validation Error",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/HTTPValidationError"
                }
              }
            }
          },
          "429": {
            "description": "Free quota exceeded",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Error": {
        "properties": {
          "error": {
            "type": "string",
            "title": "Error"
          }
        },
        "type": "object",
        "required": [
          "error"
        ],
        "title": "Error"
      },
      "HTTPValidationError": {
        "properties": {
          "detail": {
            "items": {
              "$ref": "#/components/schemas/ValidationError"
            },
            "type": "array",
            "title": "Detail"
          }
        },
        "type": "object",
        "title": "HTTPValidationError"
      },
      "Language": {
        "type": "string",
        "enum": [
          "en",
          "de"
        ],
        "title": "Language"
      },
      "Result": {
        "properties": {
          "chunk": {
            "type": "string",
            "title": "Chunk",
            "description": "A Markdown chunk containing the most relevant medical information."
          },
          "url": {
            "anyOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ],
            "title": "Url",
            "description": "The source URL with further medical information related to the chunk."
          }
        },
        "type": "object",
        "required": [
          "chunk",
          "url"
        ],
        "title": "Result"
      },
      "Results": {
        "properties": {
          "front_matter": {
            "type": "string",
            "title": "Front Matter",
            "description": "The front matter to be prepended to the results."
          },
          "results": {
            "items": {
              "$ref": "#/components/schemas/Result"
            },
            "type": "array",
            "title": "Results"
          }
        },
        "type": "object",
        "required": [
          "front_matter",
          "results"
        ],
        "title": "Results"
      },
      "ValidationError": {
        "properties": {
          "loc": {
            "items": {
              "anyOf": [
                {
                  "type": "string"
                },
                {
                  "type": "integer"
                }
              ]
            },
            "type": "array",
            "title": "Location"
          },
          "msg": {
            "type": "string",
            "title": "Message"
          },
          "type": {
            "type": "string",
            "title": "Error Type"
          }
        },
        "type": "object",
        "required": [
          "loc",
          "msg",
          "type"
        ],
        "title": "ValidationError"
      }
    }
  }
}