# Built for AI agents

> Your agent reads our docs, signs up, creates Pulses, and gets structured data back. Zero human configuration.

**URL:** https://unformal.ai/agents
**Topics:** AI agents, Agent Skill, CLI, API, Claude Code, Cursor, OpenClaw, llms.txt

## Summary

Unformal is designed to be driven end to end by AI coding agents. One pasted prompt makes an agent install the Unformal Skill, install the CLI, sign you up, verify the emailed 6-digit code and build your first Pulse — the only human step is reading that code. Installing the Skill is what teaches the agent to reach for Unformal on later requests like "collect feedback from my team". Works with Claude Code, Cursor, Windsurf and any assistant that reads context files. Signup returns an API key and 50 free credits with no credit card. Also covers OpenClaw, the CLI, real-time events, a Claude Code desktop routine, local desktop notifications and the full API reference. Site content is machine-readable: append .md to any page path, or fetch /llms.txt and /llms-full.txt.

---

Your agent reads our docs, signs up, creates Pulses, and gets structured data back. Zero human configuration.

## Paste into Claude (or Cursor, or any coding agent)

One prompt. Agent installs the skill, installs the CLI, signs you up, creates your first Pulse.

Zero setup on your end. The agent does signup, verification, CLI install, skill install, and builds your Pulse with clarifying questions. Your only job is reading a 6-digit code from your inbox.

The skill install in step 1 is the key bit — without it, the agent won't know when to reach for Unformal on future requests. With it installed, you can just say "send this to my customers" or "collect feedback from my team" and the agent picks Unformal automatically.

## Install the Skill

For Claude Code, Cursor, Windsurf — one command, then just ask in natural language

After install, just say:

"Create an onboarding Pulse for my consulting business"

Or:

"Qualify my inbound leads with a Pulse and send me results via webhook"

The skill file teaches your agent the full API — no other configuration needed. Works with Claude Code, Cursor, Windsurf, and any coding assistant that reads context files.

## Quick Start with API Key

Three steps from zero to your first Pulse

Sign up — get your API key + 50 free credits

No credit card required. API key returned immediately.

Verify your email

Check inbox for the 6-digit code, then POST it back.

Create your first Pulse

One POST with an intention — you get a shareable URL back.

That's it. Share the URL with respondents. Each person gets an AI-powered conversation. You get structured data (Echo) for every completed response. No form builder, no question writing.

## For OpenClaw

One-liner install from ClawHub

After install, your OpenClaw agent has full access to the Unformal API — creating Pulses, sharing links, and retrieving structured conversation data. No additional configuration needed.

## CLI

Everything the API can do, from your terminal or a shell script

The @unformal/cli npm package exposes every endpoint as a subcommand. Useful for quick ops, shell scripts, CI pipelines, and piping structured output to other agents via --json .

Install

Common commands

Package

@unformal/cli

Runtime

Node 18+

Source

github.com/Spark-Collective/unformal-skills

## Real-time Events

Server-Sent Events stream — get notified the moment a conversation completes

For agents that need to react in real-time (rather than polling or waiting for a webhook), connect to the SSE stream. Your agent stays connected and receives events as they happen.

Connect to the stream

Example event payload

Max connections

5 per API key

Keepalive

Ping every 15s

Timeout

30 min (reconnect)

## Claude Code Desktop Routine

Recurring digest that appears in your Claude Code sidebar alongside other routines

The easiest way to get notified. Ask Claude Code to create a desktop routine — it gets added to your sidebar as a proper routine, runs locally on your machine with access to your secrets and files, and you pick the schedule visually in the desktop UI.

Just ask Claude Code

Claude will create a SKILL.md file at ~/.claude/scheduled-tasks/&lt;name>/ . After that, open Claude Code desktop, find the routine in the sidebar, and set its schedule (Daily / Weekdays / Custom).

Runs on

Your local machine

Schedule

Set in desktop UI

Appears in

Claude Code sidebar

## Desktop Notifications (Local)

Real-time macOS toasts — runs on your machine, reacts the moment a response lands

A tiny shell script that connects to the SSE stream, pops a native notification on every completion, and writes each event to ~/.unformal/inbox/ so your Claude Code session can read it on demand.

Install and run

What you'll see

Platform

macOS (native), Linux (notify-send)

Inbox

~/.unformal/inbox/*.json

Script

unformal.ai/unformal-listen.sh

## Full API Reference

Complete endpoint documentation and schema

API Docs

Human-readable reference

llms.txt

LLM-optimized spec

## Common questions

### Can an agent set up Unformal without me?

Almost. One pasted prompt handles skill install, CLI install, signup, verification and building the first Pulse. Your only manual step is reading the 6-digit code from your inbox.

### Why does installing the Skill matter?

Without it the agent does not know when to reach for Unformal. With it installed you can say 'send this to my customers' and the agent picks Unformal automatically.

### Which agents does it work with?

Claude Code, Cursor, Windsurf and any coding assistant that reads context files. OpenClaw is covered separately.

### How should an agent read this site?

Append .md to any page path for clean markdown, fetch /llms.txt for the index, or /llms-full.txt for the entire site in one request.
