Bkper API Reference
Complete API reference for Bkper — REST APIs, bkper-js, bkper-gs, bkper-api-types, bkper-web-auth, and bkper-web-design tokens.
Technical reference documentation for Bkper APIs and SDKs. Use the public self-service path below, then choose the interface that fits your workflow.
Start building
-
Start with a free Bkper account
Open Bkper Pricing, choose Start free, and sign in. The Free plan requires no credit card.
-
Install the official CLI
npm install -g bkper -
Authenticate
bkper auth loginThe CLI starts Bkper’s self-service Google OAuth authorization flow and stores the resulting credentials locally.
-
Verify access with a read-only command
bkper book list
This path uses your real Bkper account and its existing Book permissions. Bkper does not provide a separate API sandbox.
Choose an interface
Bkper REST API Full OpenAPI reference for the Bkper REST API — endpoints, parameters, and response schemas.
Bkper AI API OpenAPI reference for Bkper AI — discover models and create complete or streaming responses.
bkper-js JavaScript/TypeScript client library for Bkper — classes, interfaces, and type definitions.
bkper-gs Google Apps Script library for Bkper — use Bkper directly in Google Sheets and Apps Script projects.
bkper-web-auth Web authentication SDK for Bkper — OAuth flows, token management, and session handling.
bkper-api-types TypeScript type definitions for the Bkper API — shared interfaces and enumerations.
Bkper Web Design Tokens CSS design tokens — typography, spacing, colors, and theming for Bkper web applications.
Public contracts and discovery
- Bkper REST OpenAPI specification — machine-readable OpenAPI 2.0 contract.
- Bkper REST API authentication and direct usage — base URL, bearer authentication, and request examples.
- Bkper developer setup — CLI installation, authentication, and local scripting setup.
- Bkper CLI reference — commands, output formats, scripts, and app workflows.
- Bkper REST OAuth protected-resource metadata — authorization server, bearer method, supported scope, and documentation discovery.
- Bkper webhooks and event handlers — event payloads, delivery, authentication, responses, retries, and loop prevention.
- Bkper MCP setup — canonical setup for conversational connector access.