Pulse Public API

Base URL: https://pulse.fruitfulbough.uk/api/v1 · Machine-readable spec: openapi.json

Authentication

Authorization: Bearer pk_live_…

Create keys in the admin console. Each key carries least-privilege scopes; a request that needs a scope the key lacks returns 403 insufficient_scope.

Idempotency

Send an Idempotency-Key header on POSTs; a retry with the same key returns the original response instead of acting twice.

Scopes

ScopeGrants
conversations:readRead conversations & message history
conversations:writeSend messages into conversations
tickets:readRead support tickets
knowledge:writeIngest knowledge-base documents
usage:readRead usage & billing counters

Endpoints

GET  /me
GET  /usage                         (usage:read)
POST /messages                      (conversations:write)
GET  /conversations                 (conversations:read)
GET  /conversations/{id}/messages   (conversations:read)
GET  /tickets                       (tickets:read)
POST /knowledge                     (knowledge:write)