SoundRipAPI Studio

{{ specVersion }}

Endpoints

expandcollapse

▶{{ a.code }}{{ a.name }}{{ a.meta }}

▶{{ g.name }}{{ g.screens }}{{ g.count }}

{{ runAllSummary }}

{{ loadingText }}

Live areas · {{ liveAreaNames }}

{{ entCount }} endpoints, {{ scenarioCount }} scenarios, {{ flowCount }} flows.

Pick an endpoint on the left to read it and call it on the right. Everything here is generated from soundrip.api.json — the same file the mock, the tests and Claude's brief are built from.

Environment

Last full run

Every scenario, every flow, the realtime round-trips and the security sweep. Mock is reset first.

Test accounts

marisol@vega.studio · member
night@porter.fm · live broadcaster
lee@drift.fm · unconfirmed
tobi@adeyemi.ng · disposable
password: hunter22!

For the mobile team

Host this folder (node server.mjs) and point the app's base URL at /v1. The mock keeps state, sends "emails" to /__mock/inbox, and behaves exactly like the contract says.

For the backend

Switch to Local, run the same tests against the real server. A red check is a precise bug report: endpoint, scenario, field.

For Claude Code

Export → CLAUDE.md, one tasks/<AREA>.md per area and errors.json into the backend repo. Claude builds down the task list and uses the CLI (npm run contract) as its definition of done.

Request log
{{ l.status }}{{ l.method }} {{ l.path }}{{ l.ms }} ms{{ l.env }}

{{ op.area }}/{{ op.tier }}/{{ op.operationId }}

Auth: {{ op.auth }} Rate limit: {{ op.rate }}

Securityrole · {{ op.secRole }}confirmed email · {{ op.secConfirmed }}strict body · {{ op.secStrict }}rate key · {{ op.secRate }}{{ op.secPii }}

{{ op.reqTitle }}

Responses

{{ r.example }}

Errors → UI state

Implementation notes · for whoever builds it

•{{ n }}

Acceptance checklist

Scenarios run in order against the current environment with your saved tokens; "Run all tests" in the sidebar resets the mock first and runs everything.

Registry

{{ errCount }} error codes.

Every non-2xx response is { error: { code, message, …details } }. A code not in this list fails the contract test.

StatusCodeMessageScreensUI state

Models

{{ modelCount }} shared schemas.

{{ m.example }}

Flows

{{ flowCount }} end-to-end runs.

Each flow resets the mock, then chains real calls — tokens and inbox links are carried from step to step. Runs against {{ envLabel }}.

For the app team

{{ screenCount }} screens, each with its calls, events and errors.

Same codes as Prototype v3. For every screen: what to call when it opens, what each tap calls, which realtime events it reacts to, and what to show for each error code. {{ clientOnlyCount }} screens need no API at all and say so.

{{ a.code }} · {{ a.name }} {{ a.count }}

On open

•{{ o }}

Then: {{ s.then }}

Actions

{{ a.k }}→{{ a.v }}

Realtime

Errors

—{{ r }}

Security standard · API + Flutter

Every rule is written down; the automatable ones run on every test.

Automated sweep · {{ secSweepCount }} endpoints

For each endpoint: no token → 401 · forged token → 401 · unknown body field → 422 · non-owner → 403 · no dob / password in the response.

✗ {{ f.key }} {{ f.detail }}

•{{ i }}

Per-endpoint matrix

EndpointRoleConfirmedStrict bodyRate key

For the backend team & Claude

Everything that is not an endpoint.

Data model, the services around the API, background jobs, security rules, observability, environments and the definition of done. Exported as BACKEND.md next to CLAUDE.md.

Entities

Services

{{ l.title }}

•{{ i }}

Realtime · WebSocket {{ rtUrl }}

REST writes, realtime reads.

One socket per app session. Subscribe to home, user or stream:{id}; every write you make in the playground shows up here as an event. Simulate the broadcaster to see the six on-air states.

Unsubscribe

Ping

Typing

{{ q.label }}

Simulate the broadcaster · {{ rtSimStream }}mock only

Event log · {{ rtCount }}

clear

Nothing yet. Connect, subscribe to stream:str_np_live, then send a chat message from the playground or press a simulate button.

Realtime tests

{{ rtTestSummary }}

{{ t.detail }}

Client → server

{{ o.op }} {{ o.fields }}
→ {{ o.reply }}

Channels

{{ c.name }} · {{ c.auth }}
{{ c.events }}

Event catalogue · server → client

{{ ev.example }}

Implementation notes

•{{ n }}

Export

Handoff files, generated from the contract.

Drop these into the backend repo. Claude Code reads CLAUDE.md first, then works down one tasks file per area; the CLI proves each box.

Backend stack · D5

CLAUDE.md is written in the idiom of the selected stack. The contract and tests do not change.

Download handoff · {{ handoffCount }} files

Or from a terminal: node export.mjs --out ../soundrip-backend --stack <id> --base https://api-staging.soundrip.app — writes CLAUDE.md, api/ (contract, errors, tasks, MOBILE, BACKEND, SECURITY, seed, Postman + 3 environments) and tests/contract/.

{{ t.label }}

Download {{ exportFile }}

{{ exportText }}

Playground

In-browser mock. Same engine the hosted server runs; state lives in this tab.

Scenario

Headers · JSON

Body · JSON

Response{{ respStatus }} · {{ respMs }} ms

{{ respBody }}

Session vars

clear

access_token · {{ varAccess }}
refresh_token · {{ varRefresh }}
user · {{ varUser }}

Reset mock

No emails yet. Sign up or request a reset.

to {{ m.to }}

{{ m.link }} ↗