IPIP Research API

Build with it

API quickstart & reference

The research API is available over HTTPS. Sign in to create, view and revoke your API keys, then try a request with the examples in your dashboard. The endpoints below are experimental and subject to published versioning.

Prototype endpointPurpose
GET /api/healthzPrototype health response
GET /api/v1/instrumentsList available instruments
POST /api/v1/keysGenerate a key while signed in (browser-session + CSRF token)
POST /api/v1/instrumentsCreate a private experimental instrument with an authenticated researcher session or authorized bearer key

The live experimental backend also supports study creation, participant sessions, scoring models and comparison analyses. Use the researcher dashboard to explore the currently implemented routes; validation and public-release gates remain separate.

POST /api/v1/instruments   # create an experiment
POST /api/v1/studies       # create a study
POST /api/v1/sessions      # start a session
POST /api/v1/responses     # submit responses
POST /api/v1/models        # create scoring model
POST /api/v1/analyses      # compare models

For scoring integration, the bearer token belongs on the calling server and must never be embedded in page JavaScript. No personal information should be put into URLs or screenshots.