Skip to main content

​
1. Create an Account

Sign up for the platform and create your account. Then generate an API key from your dashboard.

​
2. Try the Playground

Before writing code, try the Playground to test prompts and see agents in action.
Subconscious Playground
Build with AI coding assistants: Install our skill to get expert Subconscious guidance while coding:
npx skills add https://github.com/subconscious-systems/skills --skill subconscious-dev
This gives Claude Code, Cursor, and other AI assistants deep knowledge of Subconscious patterns—perfect for vibecoding your next agent app!

​
3. Choose Your Path

The fastest way to get started is using our template generator: 
npx create-subconscious-app
This interactive CLI lets you choose from pre-built examples:
  • E2B CLI Agent - Autonomous agent with secure code execution
  • Search Agent CLI - Web research agent with streaming
  • Structured Output (TypeScript) - Type-safe responses with Zod
  • Structured Output (Python) - Type-safe responses with Pydantic
  • Convex Real-time App - Full-stack app with real-time updates
See Templates for details on each example.

​
Option B: Install the SDK

Step 1: Install the SDK 
npm install subconscious
Step 2: Run Your First Agent 
import { Subconscious } from "subconscious";

const client = new Subconscious({
  apiKey: process.env.SUBCONSCIOUS_API_KEY!,
});

const run = await client.run({
  engine: "tim-gpt",
  input: {
    instructions:
      "Search for the latest AI news and summarize the top 3 stories",
    tools: [{ type: "platform", id: "web_search" }],
  },
  options: { awaitCompletion: true },
});

console.log(run.result?.answer);
That’s it! You’ve just run your first agent.

​
Next Steps

Templates

Explore pre-built examples and templates

Core Concepts

Learn about Runs, Tools, Streaming, and more

Engines

Explore available models and their capabilities

Streaming

Stream responses in real-time

API Reference

Full API documentation