API Reference

WindPipeDB API

The WindPipeDB API is available to Windipi testers. It's not open to the public yet, and some features may not work as expected.

Available to testers

The API is live and available to Windipi testers. Access is by invitation only — there's no public sign-up, and the API is not publicly reachable.

Some features may not work

The API is under active development. Features may break, change, or behave unexpectedly. Testers should expect rough edges — please report anything that doesn't work.

Overview

The WindPipeDB API lets you interact with databases programmatically — creating them, reading and writing records, and managing access.

It's currently available to Windipi testers for testing and early usage. Public access is not available yet.

Tester build: The API works, but it's an early version. Some features may not work, and behavior can change between testing rounds.

Tester access

The API is available only to Windipi testers. There is no public sign-up, and requests from outside the tester group won't be served.

  • Invitation only — tester access is granted by Windipi.
  • Tester keys — issued directly by us; no self-serve keys.
  • No public sign-up — you can't request access publicly at this time.
  • No public base URL — the endpoint isn't publicly reachable.

Not a tester? Public access is coming later. Until then, this page is for reference and for testers working with the API.

Endpoints

These are the endpoints available to testers. They are not publicly reachable, and some may not work reliably.

Databases

GET /v1/databases Tester

List the databases available to the caller.

POST /v1/databases Tester

Create a new database.

GET /v1/databases/{id} Tester

Get details for a single database.

Records

GET /v1/databases/{id}/records Tester

List records within a database.

POST /v1/databases/{id}/records Tester

Create a new record.

GET /v1/databases/{id}/records/{recordId} Unstable

Fetch a single record by ID. May not work reliably yet.

Expect rough edges. These endpoints are available to testers, but not all of them are fully stable. If something doesn't work, it's not you — it's us. Please report it.

Stability & known issues

The API is in active development. Things change, and not everything works yet. Here's the current picture:

  • Version: v1 (tester build).
  • Stability: experimental — features may break or change.
  • Known issues: some features may not work as documented.
  • Public release: to be announced.
Features may not work

Because the API is still evolving, not every feature is guaranteed to work. Testers should try things out, expect occasional failures, and share feedback.

← Back to docs