HWP 읽어 주는 GPT, HWP.Chat

HWP 읽어 주는 GPT, HWP.Chat · Actions GPT

HWP.Chat API

HWP.Chat API를 통해 GPTs 관련 내용을 조회할 수 있습니다.

  • GET /content/gpts/{uuid}GPTs 내용 조회

    주어진 UUID에 해당하는 GPTs의 내용을 조회합니다.

  • POST /content/gpts/{uuid}GPTs 질문에 대한 답변 생성

    주어진 UUID와 연관된 GPTs 내용에 대한 질문을 제출하고, 관련된 답변을 받습니다.

Schéma original API
{
  "openapi": "3.0.0",
  "info": {
    "title": "HWP.Chat API",
    "version": "1.2.0",
    "description": "HWP.Chat API를 통해 GPTs 관련 내용을 조회할 수 있습니다."
  },
  "servers": [
    {
      "url": "https://api.hwp.chat"
    }
  ],
  "paths": {
    "/content/gpts/{uuid}": {
      "get": {
        "summary": "GPTs 내용 조회",
        "description": "주어진 UUID에 해당하는 GPTs의 내용을 조회합니다.",
        "operationId": "getGptsContent",
        "parameters": [
          {
            "in": "path",
            "name": "uuid",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "조회하고자 하는 GPTs의 UUID"
          }
        ],
        "responses": {
          "200": {
            "description": "성공적으로 내용을 조회함",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/GptsContentResponse"
                }
              }
            }
          },
          "404": {
            "description": "주어진 UUID에 해당하는 내용을 찾을 수 없음"
          }
        }
      },
      "post": {
        "summary": "GPTs 질문에 대한 답변 생성",
        "description": "주어진 UUID와 연관된 GPTs 내용에 대한 질문을 제출하고, 관련된 답변을 받습니다.",
        "operationId": "postGptsQuestion",
        "parameters": [
          {
            "in": "path",
            "name": "uuid",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "description": "질문이 관련된 GPTs의 UUID"
          }
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "question": {
                    "type": "string",
                    "description": "GPTs에 제출할 질문"
                  }
                }
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "질문에 대한 답변을 성공적으로 받음",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/GptsResponseItem"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "GptsContentResponse": {
        "type": "object",
        "properties": {
          "contentTitle": {
            "type": "string",
            "nullable": true,
            "description": "내용의 제목. 내용이 없는 경우 null이 될 수 있음"
          },
          "uuid": {
            "type": "string",
            "format": "uuid",
            "description": "내용의 UUID"
          },
          "isGptsOnly": {
            "type": "boolean",
            "description": "해당 내용이 GPTs 전용인지 여부"
          }
        }
      },
      "GptsResponseItem": {
        "type": "object",
        "properties": {
          "pageContent": {
            "type": "string",
            "description": "페이지의 내용"
          },
          "pageNumber": {
            "type": "integer",
            "format": "int32",
            "description": "페이지 번호"
          }
        }
      }
    }
  }
}