FramePlanner API Schema - jonigata/FramePlanner2 GitHub Wiki

API呼び出し時のスキーマ

GPTsからFramePlanner APIを呼び出すときは、このスキーマを使います(GPTsのActionからコピペしたものです)。

{
  "openapi": "3.1.0",
  "info": {
    "title": "FramePlanner API",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://us-central1-frameplanner-e5569.cloudfunctions.net"
    }
  ],
  "paths": {
    "/addStoryboard": {
      "post": {
        "summary": "Add data to the FramePlanner system",
        "operationId": "addStoryboard",
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "characters": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "name": {
                          "type": "string"
                        },
                        "appearance": {
                          "type": "string"
                        }
                      },
                      "required": [
                        "name",
                        "appearance"
                      ]
                    }
                  },
                  "pages": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "properties": {
                        "scenes": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "composition": {
                                "type": "string"
                              },
                              "bubbles": {
                                "type": "array",
                                "items": {
                                  "type": "object",
                                  "properties": {
                                    "owner": {
                                      "type": "string"
                                    },
                                    "speech": {
                                      "type": "string"
                                    }
                                  },
                                  "required": [
                                    "owner",
                                    "speech"
                                  ]
                                }
                              }
                            },
                            "required": [
                              "composition",
                              "bubbles"
                            ]
                          }
                        }
                      },
                      "required": [
                        "scenes"
                      ]
                    }
                  }
                },
                "required": [
                  "characters",
                  "pages"
                ]
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Data added successfully"
          },
          "400": {
            "description": "Invalid request"
          }
        }
      }
    }
  }
}