---
title: API
---

# API

The API exposes bitdrift platform capabilities as schema-first service definitions maintained
in [`bitdriftlabs/api`](https://github.com/bitdriftlabs/api), specifically under the
[`bitdrift.public.*` package prefix](https://github.com/bitdriftlabs/api/tree/main/src/bitdrift/public).

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](calling-the-api.md).

## Start here

- **[Calling the API](calling-the-api.md):** choose a transport, pick an auth mode, and make your
  first request.
- **[Services](../api/services.md):** browse callable service endpoints and method-level summaries.
- **[Types](../api/reference.md):** browse generated messages and enums.
- **[Action IDs](concepts/action-ids.md):** see the first higher-level concept guide for an API
  concept that appears across multiple workflow-backed endpoints.

## API families

- **[Admin](../api/bitdrift_public_unary_admin_v1_AdminService.md):** manage API keys, SDK keys,
  connectors, and related organization configuration.
- **[Workflows](../api/bitdrift_public_unary_workflows_v1_WorkflowService.md):** create, deploy,
  query, and inspect workflow-backed telemetry. For captured-session reads, see
  [WorkflowDataService](../api/bitdrift_public_unary_workflows_v1_WorkflowDataService.md).
- **[Issues](../api/bitdrift_public_unary_issues_v1_IssueService.md):** list and inspect issue
  groups, issues, and feature flag correlations.
- **[Dashboards](../api/bitdrift_public_unary_dashboards_v1_DashboardService.md):** query chart
  metadata and chart data.
- **[Timeline](../api/bitdrift_public_unary_timeline_v1_TimelineService.md):** hydrate sessions
  and retrieve session metadata or logs.
- **[Debug files](../api/bitdrift_public_unary_debug_files_v1_DebugFileService.md):** list
  uploaded symbol and debug file assets.

## Relationship to the source repository

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