Skip to content
View as Markdown

API

Reference: Services ยท Types

The API exposes bitdrift platform capabilities as schema-first service definitions maintained in bitdriftlabs/api, specifically under the bitdrift.public.* package prefix. Use this section to orient yourself before jumping into the generated endpoint and type reference.

What this API is

The API is the contract behind higher-level operations like workflow management, issue and timeline queries, dashboards, admin configuration, and debug file access. This docs section covers the queryable public API definitions under bitdrift.public.*, not every protobuf or schema file in the repository. The generated reference in this docs site is derived from those definitions and shows the concrete request, response, and example payload shapes for each service.

Supported transports

The same API surface is available through multiple transport layers:

Transport When to use it Notes
gRPC Native typed clients and backend-to-backend integrations Use the protobuf service definitions as the source of truth.
Connect (Buf Connect) Browser, edge, or polyglot clients that want the same schema with Connect tooling Works from the same service definitions as the gRPC surface.
gRPC over JSON Quick exploration, scripts, and environments where plain HTTP + JSON is easiest The generated service pages include curl examples against https://api-public.bitdrift.io/<full.service>/<method>.

Start here

  • Services: browse callable service endpoints and method-level summaries.
  • Types: browse generated messages and enums.
  • Action IDs: see the first higher-level concept guide for an API concept that appears across multiple workflow-backed endpoints.

API families

  • Admin: manage API keys, SDK keys, connectors, and related organization configuration.
  • Workflows: create, deploy, query, and inspect workflow-backed telemetry.
  • Issues: list and inspect issue groups, issues, and feature flag correlations.
  • Dashboards: query chart metadata and chart data.
  • Timeline: hydrate sessions and retrieve session metadata or logs.
  • Debug files: list uploaded symbol and debug file assets.

Relationship to the source repository

The protobuf and related schema definitions live in the public bitdriftlabs/api repository. For the queryable API documented here, the relevant source lives under the bitdrift.public.* package space. This docs site adds generated reference pages plus higher-level guides for concepts that are easier to explain outside the raw schema.