API Overview

The Silos REST API is a resource-oriented HTTP interface for managing everything in the platform programmatically: projects, databases, branches, compute endpoints, roles, operations, usage, and running SQL directly over HTTP.

The API is deliberately Neon-shaped. Resources, paths, and request shapes mirror Neon's API closely, so if you're migrating from Neon — or already have tooling built against that surface — the mental model carries over. See the resource pages for the exact Silos paths.

Base URL

All endpoints are served under the /v1 prefix:

https://api.silos.sh/v1

Authentication

Requests authenticate with an API key passed as a Bearer token. See Authentication for how to create and use keys.

curl https://api.silos.sh/v1/projects \
  -H "Authorization: Bearer $SILOS_API_KEY"

Resources

Conventions

• JSON everywhere. Requests and responses use application/json. Send a Content-Type: application/json header on requests with a body.
• IDs are prefixed. Resource IDs carry a type prefix — proj_ for projects, db_ for databases, br_ for branches — so they're self-describing.
• Mutations are explicit. Creates use POST, partial updates use PATCH, and deletes use DELETE.
• Some actions are asynchronous. Provisioning, restores, and similar long-running work return an operation you can poll.

A quick tour

Create a database, list it, and run a query:

# Create a database in a project
curl -X POST https://api.silos.sh/v1/projects/proj_abc123/databases \
  -H "Authorization: Bearer $SILOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "my-app", "region": "iad" }'

# List databases
curl https://api.silos.sh/v1/databases \
  -H "Authorization: Bearer $SILOS_API_KEY"

# Run SQL over HTTP
curl -X POST https://api.silos.sh/v1/sql/db_abc123 \
  -H "Authorization: Bearer $SILOS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "query": "select version();" }'