The Upstreet Agent SDK is now in public beta šŸŽ‰Ā Get started ā†’
Getting StartedCreate an Agent

Create an Agent

Build AI Agents in minutes with the Upstreet Agents SDK.

Upstreet AI Agents are autonomous, customizable digital entities that handle tasks, communicate, and interact based on configurations you set.

Not sure what Agents are? Learn more about Agentic AI, and the concepts behind it, in our Concepts.

Quickstart: Creating an Agent

With Upstreet, getting started is easy. Hereā€™s how to set up your first Agent.

Step 1: Running the command

  1. Set up your project directory
    First, create an empty directory where youā€™d like to set up your Agent.

  2. Run the Command in your terminal

    usdk create

    Run the above command in your terminal within your new directory. This will launch a guided interview, where youā€™ll define essential properties of your Agent.

    You can see more options by running usdk create --help.

Step 2: Complete the Agent Interview

The usdk create command initiates an interactive ā€œinterviewā€ process with the Interviewer. Hereā€™s what to expect:

  1. Interactive Prompts
    The SDK will prompt you with questions, helping you define your Agent's personality, environment, and other key settings.

  2. Simulated Chat with Your Agent
    Youā€™ll be able to ā€œconverseā€ with the Interviewer, defining the Agent's Homespace (its natural habitat) and personality traits through chat-based interactions.

  3. Completion
    Once all required fields are captured, the interview concludes, setting up all the Agent features and initialising the necessary files in your directory.

File Structure

Letā€™s say you named your project directory ā€œmy-agentā€. After running usdk create, hereā€™s what your setup will look like:

agent.tsx
jest.config.mjs
jest.setup.mjs
package-lock.json
package.json
tsconfig.json
wrangler.toml

Remember to keep your Agentā€™s configuration secure. Avoid making this repository public on platforms like GitHub, as sensitive keys could be exposed.

What's next?

Now that you've set up your base Agent, you can choose to dive deeper into Agent customization and potential capabilities by writing code in React.

If you wish to skip customization and directly launch your Agent on our Platform, you can check out Testing your Agent and Deploying your Agent.

On this page