Pineapple Builder | AI Website Builder

Pineapple Builder | AI Website Builder · Actions GPT

Get your website

Retrieves website's design

  • GET /api/custom-gpt/website-generationGenerateWebsite

    Generate Website based on your business details.

Schéma original API
{
  "openapi": "3.1.1",
  "info": {
    "title": "Get your website",
    "description": "Retrieves website's design",
    "version": "v1.0.2"
  },
  "servers": [
    {
      "url": "https://app.pineapplebuilder.com"
    }
  ],
  "paths": {
    "/api/custom-gpt/website-generation": {
      "get": {
        "description": "Generate Website based on your business details.",
        "operationId": "GenerateWebsite",
        "parameters": [
          {
            "name": "templateId",
            "in": "query",
            "description": "Website template, which will be a starting point for future customisation.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "kale",
                "zain",
                "cecily",
                "pika",
                "malia"
              ]
            }
          },
          {
            "name": "businessName",
            "in": "query",
            "maxLength": 30,
            "description": "Business Name. If not provided propose name for my business matching description. Input string can't be longer than 1 word.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "businessDetails",
            "in": "query",
            "maxLength": 400,
            "description": "Business Details eg. What business does, what are the benefits. Input string can't be longer than 70 words and should be more than 60 words.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "targetAudience",
            "in": "query",
            "maxLength": 250,
            "description": "Target Audience of business. Input string can't be longer than 30 words and should be more than 20 words.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "websiteType",
            "in": "query",
            "description": "Type of the website to create.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "blog",
                "business_website",
                "digital_shop",
                "educational_site",
                "landing_page",
                "one_page",
                "personal",
                "portfolio",
                "sell_services"
              ]
            }
          },
          {
            "name": "websiteGoals",
            "in": "query",
            "description": "Main goal for the website. Pick one value.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "affiliate_program",
                "convert_traffic",
                "directories",
                "gather_leads",
                "grow_traffic",
                "inform_visitors",
                "sell_products"
              ]
            }
          },
          {
            "name": "brandPersonality",
            "in": "query",
            "description": "Brand personality attributes. Pick one value.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "approachable",
                "authentic",
                "dynamic",
                "innovative",
                "trustworthy",
                "user_friendly"
              ]
            }
          },
          {
            "name": "language",
            "in": "query",
            "description": "Language in which was the user's prompt",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "ar",
                "bg",
                "zh",
                "cs",
                "da",
                "nl",
                "en",
                "fil",
                "fi",
                "fr",
                "de",
                "el",
                "he",
                "hi",
                "hu",
                "id",
                "it",
                "jp",
                "ko",
                "ms",
                "no",
                "pl",
                "pt",
                "ro",
                "ru",
                "sk",
                "es",
                "sv",
                "th",
                "tr",
                "uk",
                "vi"
              ]
            }
          },
          {
            "name": "features",
            "in": "query",
            "description": "Features to include on the website.",
            "required": true,
            "schema": {
              "type": "array",
              "items": {
                "type": "string",
                "enum": [
                  "analytics",
                  "ads",
                  "bookings",
                  "blog",
                  "code_embeds",
                  "collect_emails",
                  "chat_bot",
                  "forms",
                  "payments",
                  "translations"
                ]
              }
            }
          },
          {
            "name": "additionalInformation",
            "in": "query",
            "maxLength": 500,
            "description": "Additional specific information or requirements for the website not covered by other fields.",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "uniqueSellingPoints",
            "in": "query",
            "maxLength": 400,
            "description": "Key unique selling points of the business or service that should be highlighted on the website.",
            "required": true,
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "voiceAttributes",
            "in": "query",
            "description": "Voice attributes for website content. Pick one value.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "assertive",
                "conversational_engaging",
                "encouraging_inspirational",
                "friendly",
                "informative",
                "professional_relatable"
              ]
            }
          },
          {
            "name": "industry",
            "in": "query",
            "description": "Industry category for the business. Pick one value.",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "academic_services",
                "animal_care",
                "animation_graphics",
                "architectural_services",
                "art_creativity",
                "art_galleries",
                "authors_writers",
                "bakery_confectionery",
                "beauty_salon",
                "beverage_industry",
                "blogging_influencing",
                "brand_development",
                "cafe_culture",
                "cannabis_products",
                "catering_services",
                "charity_non_profit",
                "childcare_services",
                "cleaning_services",
                "conferences_networking",
                "construction_services",
                "consulting_services",
                "cosmetics_beauty",
                "counseling_therapy",
                "creative_productions",
                "culinary_arts",
                "delivery_services",
                "dental_practice",
                "dental_services",
                "digital_marketing_solutions",
                "digital_solutions",
                "educational_institutions",
                "educational_services",
                "electrical_services",
                "event_djing",
                "event_management",
                "event_venues",
                "fashion_design",
                "film_studio",
                "financial_services",
                "fitness_wellness",
                "floristry_gardening",
                "graphic_web_design",
                "health_coaching",
                "health_institutions",
                "healthcare_clinics",
                "home_decor_interior",
                "hospitality_industry",
                "hospitality_services",
                "insurance_services",
                "interior_design",
                "landscape_design",
                "learning_development",
                "legal_services",
                "logistics_transport",
                "marketing_advertising",
                "medical_professionals",
                "music_entertainment",
                "non_governmental_organization",
                "online_learning",
                "personal_coaching",
                "photographic_services",
                "plumbing_services",
                "podcasting",
                "professional_portfolio",
                "publishing_literature",
                "real_estate_property",
                "restaurant_services",
                "social_clubs",
                "spa_relaxation",
                "spiritual_services",
                "startup_ecosystem",
                "talent_acquisition",
                "tech_innovations",
                "therapeutic_services",
                "transportation_services",
                "travel_tourism",
                "video_blogging",
                "viticulture_winemaking",
                "wedding_planning",
                "yoga_mindfulness"
              ]
            }
          }
        ],
        "deprecated": false,
        "responses": {
          "200": {
            "description": "Successful response",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "imgUrl": {
                      "type": "string",
                      "example": "https://res.cloudinary.com/aurity/image/upload/v1668619831/elinor_placeholder_2_bfa61dafd6.png",
                      "description": "Website's template image to show user their website's general look"
                    },
                    "linkUrl": {
                      "type": "string",
                      "example": "app.pineapplebuilder.com/templates/generate-your-website",
                      "description": "The URL Link to user's generated website, which they can access without login and configure further their website."
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {}
  }
}