I Need A Database

How-to

Manage projects

Create, inspect, and delete the projects that contain your collections and documents.

Create a project

Create a project from the dashboard, or post a project name from an authenticated dashboard session. The create response includes one copy-once API key for collection and document requests.

request
POST /api/v1/projects
Content-Type: application/json

{"name":"Recipe app"}

List projects

List the projects owned by the signed-in account. The response is an object with items and next_cursor, not a bare array.

request
GET /api/v1/projects
response
{
  "items": [
    {
      "id": "recipe-app",
      "name": "Recipe App",
      "collectionCount": 1,
      "documentCount": 4
    }
  ],
  "next_cursor": null
}

Read a project

Read one project summary, including collection counts and usage.

request
GET /api/v1/projects/proj_123

Delete a project

Delete a project only when you no longer need any of its collections, documents, or API keys.

request
DELETE /api/v1/projects/proj_123