Quickstart

Get up and running with soft.house in under 15 minutes. This guide covers installation, authentication, and your first API call.

Installation

Install the SDK using npm or yarn:

npm install @soft-house/sdk

Requires Node.js 18 or later

Authentication

Get your API key from the Dashboard. Initialize the client with your key:

client.ts 
"token-keyword">import { SoftHouse } "token-keyword">from '@soft-house/sdk';

"token-keyword">const soft = "token-keyword">new SoftHouse({
  apiKey: 'sk_test_...',  // Your API key
});

API keys are only shown once. Store them securely immediately after creation.

First API Call

Create your first wish with a simple API call:

example.ts 
// Create a wish
"token-keyword">const wish = "token-keyword">await soft.wishes.create({
  query: 'Find me a laptop under $1500',
  budget: {
    max: 1500,
    currency: 'USD',
  },
  protocol: 'auto',  // Automatically selects best protocol
});

console.log('Wish created:', wish.id);
console.log('Status:', wish.status);

Response Example

The API returns a wish object with details about the request:

response.json 
{
  "id": "wish_abc123",
  "status": "active",
  "query": "Find me a laptop under $1500",
  "budget": {
    "max": 1500,
    "currency": "USD"
  },
  "protocol": "ap2",
  "created_at": "2026-01-20T10:30:00Z"
}

Next Steps

Now that you've created your first wish, explore more:

← Introduction Authentication →