API Overview

The User Evaluation Public API lets you read and write everything you can do in the app — projects, tests, transcripts, tags, insights, reports, and more — from your own scripts, integrations, and tools.

Who can use it

• Paid researcher accounts only. API keys can be generated by admin and superadmin users on Basic, Standard, or Plus plans.
• Free accounts and participant accounts get a 402 plan_required or 403 forbidden response.

Base URL

https://api.userevaluation.com/v1

Quick example

curl https://api.userevaluation.com/v1/me \
  -H "Authorization: Bearer ue_live_…"

{
  "data": {
    "id": "65f8…",
    "email": "researcher@acme.com",
    "name": "Sam",
    "role": "admin",
    "plan": "Plus Monthly",
    "workspace_id": "65f8…"
  }
}

What you can do

Group	Endpoints
Identity	/me, /workspace
Projects	List, get, create, update, delete; plus 8 nested sub-resources (tests, files, tags, notes, cards, lanes, reports, clips)
Tests & responses	Read tests, list responses, read a single response
Files & transcripts	Read file metadata (videos, audio, PDFs, docs) + signed download URL, read transcript segments
AI / async jobs	Trigger chat, reports, transcription, auto-tag, sentiment; poll job status
Engage (live interviews)	List/get/publish engage tests, list call sessions, send invitations
Webhooks	Subscribe to events, receive HMAC-signed callbacks
Usage	Per-user request stats, recent activity

The full machine-readable definition is at /v1/openapi.json — drop it into Postman, Insomnia, or your codegen tool.

Versioning

This is /v1. Additive changes (new fields, new endpoints) won't break v1 clients. Breaking changes ship as /v2 with a 12-month overlap. We never silently change response shapes.

Status

The API is generally available. See the Changelog for notable updates and the API Keys settings page for key management.