SignalAI
Open Demo

API

API Reference

This page documents the endpoints that exist in the current launch build. Workspace API endpoints require a bearer token generated from Settings. The demo health endpoint is public for launch verification.

Authentication

Send the API key in the Authorization header. API responses include rate limit headers from the workspace API key policy.

Authorization: Bearer sig_your_api_key_here

Endpoints

GET/api/v1/signalsBearer API key

Lists workspace signals with source, sentiment, date range, limit, and offset filters.

Parameters

source=slack|githubsentiment=positive|negative|neutral|mixedfrom=ISO dateto=ISO datelimit=max 100offset=number

Example

curl "https://product-plum-nu.vercel.app/api/v1/signals?limit=10&sentiment=negative" \
  -H "Authorization: Bearer sig_your_api_key_here"
GET/api/v1/patternsBearer API key

Lists detected patterns with sentiment, severity, resolved, limit, and offset filters.

Parameters

sentiment=positive|negative|neutral|mixedseverity=low|medium|high|criticalresolved=true|falselimit=max 100offset=number

Example

curl "https://product-plum-nu.vercel.app/api/v1/patterns?severity=critical&resolved=false" \
  -H "Authorization: Bearer sig_your_api_key_here"
GET/api/v1/patterns/:idBearer API key

Returns one pattern, its linked signals, and related pattern context.

Parameters

id=pattern uuid

Example

curl "https://product-plum-nu.vercel.app/api/v1/patterns/pattern_uuid_here" \
  -H "Authorization: Bearer sig_your_api_key_here"
GET/api/v1/analytics/summaryBearer API key

Returns total signals, sentiment breakdown, and top unresolved patterns for the workspace.

Example

curl "https://product-plum-nu.vercel.app/api/v1/analytics/summary" \
  -H "Authorization: Bearer sig_your_api_key_here"
GET/api/demo/healthNone

Checks whether the public demo workspace is configured and has enough sample data for launch.

Example

curl "https://product-plum-nu.vercel.app/api/demo/health"

Not documented as ready yet

Webhook delivery, third-party OAuth setup guides, and one-click export guarantees are intentionally left out of this public API page until those paths are verified end to end in production.