"Hello, World!"

Learn your way around Summit by deploying the world's most familiar function

πŸŽ“

In this tutorial, you'll learn how to ...

  • Create a new model using snippets
  • Publish a model as an API
  • Find your model's API endpoints
  • Create a parameter to define a model input variable

Video Walkthrough


Creating a Hello World App in Summit

This tutorial describes the process of creating a basic Hello World application using Summit platform by building a model, defining an event, and setting up an API to interact with the model. It includes steps to personalize the greeting with parameters and the use of Liquid Syntax.

Step 1: Start Model

Begin a new model in Summit by clicking the 'Start from scratch' button to load a blank canvas.

Step 2: Create Event

Double-click on the canvas to create an event, which is a step in a flow, and name it as your greeting.

Step 3: Edit Event

Press the letter 'E' on your keyboard to edit the event and change its type to a string with the value 'Hello World!' to serve as the greeting.

Step 4: Add Response

On the left-hand side, select the 'add response data' option and place it on your canvas to create a response event.

Step 5: Link Data

Link your greeting event to the response event by dragging the arrow from the greeting to the response to ensure the greeting string is returned in the API response.

Step 6: Check Data View

Switch to the data view at the bottom to review the response and notice the default attribute name, which will be modified.

Step 7: Rename Attribute

Update the default attribute name from 'foo' to a more sensible term such as 'greeting.'

Step 8: Publish Model

Click 'Set Live' at the top right to allow your model to be run over the web and follow the prompts to complete the publishing process.

Step 9: API Setup

Under the 'Connectivity' tab, select 'API' and use the provided endpoints to run your model. You may need to create an API key with Run Access.

Step 10: Create Parameter

Learn to personalize the greeting by creating a parameter. Add a string event for the name and use the tag format <name> to make it a model parameter (argument).

Step 11: Apply Liquid Syntax

Use Liquid Syntax to insert the parameter into your greeting by replacing 'world' with the parameter name in your greeting event string.

Step 12: Adjust Flow

Ensure the name parameter event runs before the greeting, for correct order of execution, by connecting the events with arrows.

Step 13: Update API

Set the modified model live again and check the API tab for changes, noting how the parameter can now be passed through the API for varied greetings.

General Notes

Model Parameters

Parameters allow you to customize the behavior of the model by passing specific data when making API calls.

Tools Integration

Summit allows integration with various tools such as Zapier and HubSpot for those who are not developers, enabling model connectivity without custom code.

Liquid Syntax

Liquid Syntax is used to dynamically insert parameters into text, enabling more complex and adaptable model outputs.