Skip to main content

Documentation

Documentation, honest about what exists

Bobby DB documents architecture and intent now, and behaviour only once behaviour exists. Each topic below states its own status rather than presenting a planned contract as final.

How to read these docs

“Implemented” means you can inspect it today. “Planned” means the contract is designed but not built. “Not yet available” means there is nothing to document yet. No fabricated request, response or behaviour is presented as final anywhere in these docs.

Topics

  • Quickstart

    Planned

    The shortest path from a key to a reference value: create a workspace, seed a collection, cut a release, read it with a key.

    Contract planned. Cannot be written as a working walkthrough until the API exists.

  • Authentication

    Not yet available

    How machine callers authenticate with an API key, and how human sign-in will relate to workspace membership.

    Not yet available. No authentication of any kind is implemented.

  • Workspaces

    Planned

    The tenant boundary: what a workspace owns, and what never crosses it.

    Design documented on the product page; operational contract planned.

    Product design

  • Collections

    Planned

    Visibility, schema modes, and the unit that is drafted, released and served.

    Design documented; API contract planned.

    Product design

  • Groups

    Planned

    Organising related keys inside one collection.

    Design documented; API contract planned.

  • Entries

    Planned

    Keys, typed JSON-compatible values, and what does not belong in a value.

    Design documented; field-level reference planned.

    Value model

  • Imports

    Planned

    Bringing bulk content in through parsing, mapping and validation into a draft.

    Contract planned. No import pipeline exists.

  • Drafts and Reviews

    Planned

    The editing space and the human gate between editing and publication.

    Design documented; review API contract planned.

  • Releases

    Planned

    Immutability, current versus pinned reads, and how corrections are published.

    Design documented; release API contract planned.

    Pinning behaviour

  • API Keys

    Planned

    Issuance, read and write scopes, one-time display, rotation and revocation.

    Contract planned. No key can be created today.

  • REST API

    Planned

    Base URL, pagination, batch reads, ETag revalidation, idempotency keys and request IDs.

    Planned contract published in outline, deliberately not as a full reference.

    Developer architecture

  • MCP

    Planned

    The agent delivery surface over the same governed releases.

    Endpoint and tool contract planned; nothing is served.

    REST and MCP

  • Metering and Limits

    Planned

    How requests are counted per workspace, and what happens at an allowance boundary.

    Allowances are proposed on the pricing page; metering is not implemented.

    Proposed limits

  • Errors

    Planned

    The stable error codes a client should branch on.

    Taxonomy published as a planned contract.

    Error taxonomy

  • Security

    Implemented

    The data model boundaries, key handling and what evidence does and does not exist.

    The security position page is written and current.

    Security position

  • Changelog

    Not yet available

    What changed in the platform and in published public collections.

    Not yet available. There is no released platform or collection to log.

Planned

Enough to design against

Rather than a speculative full API reference, these docs publish the architecture and a small set of representative examples.

Read shapesynthetic example
{
  "collection": "example-collection",
  "release": "example-release-version",
  "entries": [
    { "key": "example.first.key", "value": { "example": true } }
  ],
  "next_cursor": null,
  "request_id": "example-request-id-0001"
}

Illustrative response shape. Field names are not final and nothing serves this yet.

Import shapesynthetic example
{
  "target": "example-collection",
  "mode": "draft",
  "mapping": { "source_field": "example.first.key" },
  "rows": [{ "source_field": "example value" }]
}

Illustrative import submission. No import pipeline exists.

Missing a topic you need to evaluate Bobby DB? It is not published because it cannot be documented truthfully yet. Nothing here is backed by a running service, and no support channel is announced on this site.