logo

This quickstart guide will walk you through building a local travel guide application. In just 5 minutes, you'll be able to build the application and deploy it to the cloud.

You can ask simple questions like:

  • Create an itinerary for a weekend trip to Los Angeles.
  • Plan a 4-day trip to San Francisco.
  • Plan a trip to New York from January 20th to January 24th.
  • What to do in Phoenix this weekend?

Step-by-Step Guide

  1. Install AgentifyMe CLI

    First, install the AgentifyMe CLI, which provides the tools for local development and deployment:

    bash
    curl -LsSf https://agentifyme.ai/install.sh | bash

    The installation script will place the CLI in ~/.agentifyme/bin/agentifyme. Add this location to your PATH and verify the installation:

    bash
    agentifyme --version

    Log in to your AgentifyMe account, if you don't have an account, you can sign up for one here:

    bash
    agentifyme login

  2. Create a New Project

    Let's create a new directory for the project.

    bash
    mkdir my-local-travel-guide && cd my-local-travel-guide

    Create a project using our quickstart template:

    bash
    agentifyme init my-local-travel-guide --template agentifyme/local-travel-guide-py

    This command creates a new directory containing all necessary project files. Take some time to explore the generated code structure.

  3. Set Up Local Development

    In this tutorial, we'll use the OpenAI to generate responses. First, configure your OpenAI API key:

    bash
    cp .env.example .env
echo "OPENAI_API_KEY=sk-..." >> .env

    Visit http://localhost:3418 in your browser to see your development environment.

    Run the workflow in development mode:

    bash
    agentifyme dev

  4. Deploy to the Cloud

    Before deploying, securely store your OpenAI API key:

    bash
    agentifyme secret set -p .env

    Deploy your workflow to create a live API endpoint:

    bash
    agentifyme deploy

  5. Invoke Your Workflow

    curl --location 'http://localhost:34186/v1/workflows/run' \
--header 'x-wf-endpoint: my-local-travel-guide-0fc8e6bd' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <API_KEY>' \
--data '{
    "name": "search-candidates",
    "parameters": {
        "query": "What to do in Monterey this weekend?",
        "organization_id": "272e9e73-fe36-4ea1-acf6-4ea08d21aa0c",
        "filters": {}
    }
}'

  6. Monitor Your Workflow

    [This section needs content about accessing and using the monitoring dashboard, including key metrics and debugging tools]

Congratulations! 🎉

You've successfully created and deployed your first agentic workflow! Your workflow is now running in the cloud and ready to use.

Next Steps

To continue your journey with AgentifyMe:

Install CLI