Skip to content

Latest commit

 

History

History
56 lines (39 loc) · 3.47 KB

README.md

File metadata and controls

56 lines (39 loc) · 3.47 KB

TypeScript Mastra agent template

A template for Mastra projects in TypeScript for building AI agents with Apify Actors. The template provides a basic structure and an example agent that calls Actors as tools in a workflow.

How it works

An agent is created and given a set of tools to accomplish a task. The agent receives a query from the user and decides which tools to use and in what order to complete the task. In this case, the agent is provided with an Instagram Scraper Actor to scrape Instagram profile posts. The agent produces textual output, which is saved to a dataset.

How to use

Add or modify the agent tools in the src/tools.ts file, and make sure to include new tools in the agent tools list in src/agents.ts. Additionally, you can update the agent prompts in src/agents.ts. For more information, refer to the Mastra agent documentation and the Mastra tools documentation.

Pay Per Event

This template uses the Pay Per Event (PPE) monetization model, which provides flexible pricing based on defined events.

To charge users, define events in JSON format and save them on the Apify platform. Here is an example schema with the task-completed event:

[
    {
        "task-completed": {
            "eventTitle": "Task completed",
            "eventDescription": "Cost per query answered.",
            "eventPriceUsd": 0.1
        }
    }
]

In the Actor, trigger the event with:

await Actor.charge({ eventName: 'task-completed' });

This approach allows you to programmatically charge users directly from your Actor, covering the costs of execution and related services, such as LLM input/output tokens.

To set up the PPE model for this Actor:

  • Configure the OpenAI API key environment variable: provide your OpenAI API key to the OPENAI_API_KEY in the Actor's Environment variables.
  • Configure Pay Per Event: establish the Pay Per Event pricing schema in the Actor's Monetization settings. First, set the Pricing model to Pay per event and add the schema. An example schema can be found in pay_per_event.json.

Included features

  • Apify SDK for JavaScript - a toolkit for building Apify Actors and scrapers in JavaScript
  • Input schema - define and easily validate a schema for your Actor's input
  • Dataset - store structured data where each object stored has the same attributes
  • Key-value store - store any kind of data, such as JSON documents, images, or text files

Resources