docs

briven is postgresql 18 with pgvector already switched on. anything that works with postgres works here, so most of what you already know is the documentation — these pages cover the parts that are ours.

the shortest useful example

Two things get you a row: a database, and a key. Create the database in the dashboard, create an API key on the api keys page, and then this works from anywhere with an internet connection — no driver, no connection to hold open.

bash

curl -sS https://briven.tech/api/v1/sql \
  -H "Authorization: Bearer $BRIVEN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"select $1::text as hello","params":["world"],"database":"notes"}'

response

{
  "command": "SELECT",
  "rowCount": 1,
  "rows": [{ "hello": "world" }],
  "fields": [
    { "name": "hello", "dataTypeID": 25, "format": "text" }
  ]
}

If you would rather use a real Postgres connection, take the connection string instead and point psql, Prisma or Drizzle at it — connecting covers what the pooler changes and what it does not.

everything in here

start here

interfaces

features

what is not in these docs

briven does not have a hosted login system for your own end users, a functions runtime, logical replication or a schema-diff tool. API keys, history and metrics are managed in the dashboard and are not on the management API. And usage billing is not switched on — every usage rate in the product is zero and no payment provider is connected.

Something missing that you needed? Tell us. These pages are written from the code that serves them, so if one of them is wrong it is a bug and it gets fixed like one.