UserPulse Developer Docs

The Feedback API for AI Agents

Let Claude, GPT, or any LLM agent triage feature requests, file customer feedback, and update statuses on your UserPulse boards. Issue a scoped API key, paste the OpenAPI spec into your agent, ship.

Quickstart Interactive API Reference Create an API key

Scoped API keys

Pick the scope at creation: a single board or all your boards. Pick the permission: read-only or read+write.

Built for agents

Plain HTTP + JSON. Bearer tokens. An OpenAPI 3.1 spec your agent can ingest as tools.

Interactive reference

Try every endpoint live in your browser via Scalar. Copy curl, JS, and Python snippets.

Safe by default

Keys are hashed at rest, only shown once, can be revoked instantly. Read-only keys cannot mutate anything.

A 30-second tour

# 1. Create a key in UserPulse → Settings → API keys
# 2. Call the API
curl -H "Authorization: Bearer up_..." \
     https://your-deployment.convex.site/api/v1/boards

# 3. File feedback as your AI agent
curl -X POST \
     -H "Authorization: Bearer up_..." \
     -H "Content-Type: application/json" \
     -d '{"title":"Add CSV export","description":"Customers asked for it"}' \
     https://your-deployment.convex.site/api/v1/boards/product/feedback

Where to next

Quickstart → install, authenticate, and make your first request.
API Reference → interactive Scalar reference with live "Try it".
AI Agents Guide → wire UserPulse into Claude or GPT as a tool.