GUS - Universe Website Builder · Actions GPT

{
  "openapi": "3.0.3",
  "info": {
    "title": "Universe OpenAI API - OpenAPI 3.0",
    "description": "An interface for OpenAI / GPT apps to use to interface with Universe Website Builder",
    "version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://api.univer.se"
    }
  ],
  "tags": [
    {
      "name": "sitegeneration",
      "description": "Operations related to generating new websites"
    }
  ],
  "paths": {
    "/openai/v4/ai/sites/generate": {
      "post": {
        "tags": [
          "sitegeneration"
        ],
        "summary": "Generate a new website with a conversation and metadata",
        "description": "Takes an OpenAI conversation, information about the user, and summary / purpose derived by the GPT and uses it to generate a new website. Returns a snapshot image URL of the new site and a link that the user can follow to set up an account and claim that site",
        "operationId": "generateSite",
        "requestBody": {
          "description": "Information that OpenAI must send to generate us to generate a new website",
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/SiteGenerationRequest"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Site was successfully created",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SiteGenerationResponse"
                }
              }
            }
          },
          "403": {
            "description": "Universe API is not configured correctly",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UniverseError"
                }
              }
            }
          },
          "500": {
            "description": "Universe API is having temporary issues",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UniverseError"
                }
              }
            }
          },
          "502": {
            "description": "Universe API is having issues reaching back out to OpenAI",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/UniverseError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Message": {
        "type": "object",
        "description": "A message from an OpenAI conversation",
        "properties": {
          "role": {
            "type": "string",
            "enum": [
              "user",
              "assistant"
            ]
          },
          "content": {
            "type": "string"
          }
        },
        "required": [
          "role",
          "content"
        ]
      },
      "SiteGenerationRequest": {
        "type": "object",
        "properties": {
          "conversation": {
            "type": "array",
            "description": "The conversation OpenAI had with the user to generate a website",
            "minItems": 6,
            "maxItems": 10,
            "items": {
              "$ref": "#/components/schemas/Message"
            }
          },
          "purpose": {
            "type": "string",
            "description": "What the OpenAI LLM thinks the purpose is of the user's website. Should be a short single sentence."
          },
          "summary": {
            "type": "string",
            "description": "A summary of what OpenAI thinks the user wants their website to be. Should be roughly a paragraph"
          },
          "vibe": {
            "type": "string",
            "description": "A description of the general design themes / vibes of the website"
          }
        },
        "required": [
          "conversation",
          "purpose",
          "summary",
          "vibe"
        ]
      },
      "SiteGenerationResponse": {
        "type": "object",
        "properties": {
          "claim_url": {
            "type": "string",
            "format": "uri",
            "description": "A link that the user can click to finish setting up their account and claim the generated website"
          },
          "snapshot_url": {
            "type": "string",
            "format": "uri",
            "description": "A preview image showing what the generated site looks like"
          }
        }
      },
      "UniverseError": {
        "type": "object",
        "properties": {
          "message": {
            "type": "string"
          },
          "can_retry": {
            "type": "boolean"
          },
          "contact_support": {
            "type": "boolean"
          }
        }
      }
    }
  }
}