Skip to main content

How do I use the Bubbles API?

K
Written by Kristi Panta

Create an API key and start building with the Bubbles API.
Bubbles has a public API that lets you (or your developers) read your teams, bubbles, transcripts, and comments, and build on top of them. Here's how to get started.


Create an API key

This creates what Bubbles calls a personal access token, the same credential the Quickstart walks you through using.

Creating a key needs a paid Bubbles workspace, and you can have up to 10 active keys.

  1. Go to API keys settings (or Settings → Personal → API keys).

  2. Give the key a name, something that tells you what it's for later, like "CLI" or the name of the integration.

  3. Click "Create key."

Your key only shows up once, right when you create it. Copy it somewhere safe immediately, because there's no way to look it up again afterward. You'd have to make a new one.

Make your first call

With your key in hand, the Quickstart walks through setting your base URL and making your first call. The API sits under a versioned /v1 prefix.

Need OAuth instead?

If you're building something that other people will log into, rather than just using your own key, you'll want OAuth. The Authentication guide covers the full flow, including how tokens get issued and refreshed.

Find the full API details

For the full list of what each endpoint accepts and returns, request/response examples, pagination, error handling, and rate limits, the API Reference is the place to check.

Looking for something else?

Good to know

  • The API and the AI assistant connection are separate. You don't need an API key just to connect an assistant.

  • Everything developer facing lives at docs.usebubbles.com if you need more technical depth than what's here.

Still stuck?

  • Can't create a key: creating a key needs a paid Bubbles workspace.

  • Unauthorized error: check that your key is sent in an Authorization: Bearer header and was copied in full.

  • Token revoked error: the key was revoked, so create a new one.

Still having trouble? Email us at [email protected] with your workspace name and what you're seeing. A screenshot of the error helps us move faster.

Did this answer your question?