Skip to content

Getting Started using Sample Applications

Griptape Cloud provides a few sample applications to help you get started quickly. These applications will likely change over time as new functionality is introduced, or new models become available. At the time of this writing, there is a sample called Chat with a Poet, but any other sample application you see on your New App screen should follow the same process. Let's dive in.

Create a New App

While logged in to Griptape Cloud, you'll see a button labeled + New App on your left side bar. Click that button to navigate to the New App screen.

New App Screen

Again, your available sample applications might vary. We're going to continue by clicking on the Chat with a poet application template.

Once you click on the template, you'll be taken to the application's main page where you'll find an in-browser IDE and some controls to work with your application.

Working with your Griptape App

App Main Screen

The first thing to notice after creating a new application is the status indicator in the top right of the screen. It should be blinking blue on first visit. This means the application template is still deploying. When it's green, you're ready to proceed.

Status Indicator

Setting your OpenAI API Key

At the time of this writing, the provided templates default to using OpenAI underneath. If you don't have an API Key from OpenAI, you can follow the Setup course from Griptape Trade School.

Currently, Griptape Cloud applications load environment variables using a .env file in the project's main directory. In the in-browser IDE, you'll find a file navigator column on the left. Select the .env file to open it in the IDE.

OpenAI API Key

Replace YOUR_API_KEY with your OpenAI API Key. We've made a change to the template. Any changes you make to the code in your application need to be re-deployed before you can use them.

Re-deploying changes to your Griptape App

If changes are detected, the button labeled Deploy will switch from disabled to enabled. You can click this button to Deploy your changes.

During deployment, the status indicator icon should switch from green to blue. Other than your first deployment during app creation, deployments should be relatively quick with Griptape Cloud.

WHen the status indicator is green, you're ready to test your first application!

Running your Griptape Cloud App

Congratulations. You're ready to run your first Griptape Cloud app. In the right hand side of the in-browser IDE, you'll find a conversational interface to your application. Anything you type in place of Enter a prompt will be sent to the application. Type in Write me a Haiku about Skateboarding. You should get a result similar to the following.

This particular application template uses Griptape Rulesets to steer the personality of the Agent.

First Run