API¶
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. The generated reference in this docs site is derived from the protobuf definitions and shows the concrete request, response, and example payload shapes for each service.
Supported transports¶
The API is available over gRPC, Connect, and gRPC over JSON. For transport selection, authentication, and practical usage guidance, see Calling the API.
Start here¶
- Calling the API: choose a transport, pick an auth mode, and make your first request.
- 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. For captured-session reads, see WorkflowDataService.
- 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.