Quickstart

Get started with PromptStream in minutes

Quickstart — Three Steps to Your First Prompt

Follow these steps to create an account, add a prompt, and run it via the SDK.

Step 1: Create your account & organisation

Sign up

1. Go to PromptStream Sign Up. 2. Enter your details, and our team will be in touch!

Step 2: Create your first prompt

Add a new prompt

1. In the sidebar, navigate to Prompts → New Prompt. 2. Fill in:

• Name: e.g. welcome-message - Description: e.g. “Greet users with style” - Template: txt Hello {user_name}, welcome to PromptStream! 3. Click Save Prompt. Version 1 is created automatically.

Step 3: Install the SDK and run your prompt

Install the SDK

npm install promptstream
# or
yarn add promptstream

Initialize and run

import { PromptStreamClient } from 'promptstream';

const client = new PromptStreamClient({
  apiKey: 'YOUR_API_KEY',
  externalUserId: 'user-123',
});

async function runPrompt() {
  const response = await client.run_prompt({
    promptId: 'welcome-message',
    inputs: { user_name: 'Alice' }
  });
  console.log(response.output);
}

runPrompt();

Next Steps

React SDK

Capture clicks, ratings, and engagement with our React components.

Developer Docs

Full API & SDK reference on Mintlify.