PulseAPI
An overview of the API for retrieving notes and transcripts from external systems, its scopes, and managing keys.
The API lets your own systems and scripts retrieve meeting notes, transcripts and AI-enhanced notes programmatically. When you create an API key, you choose the range of notes that key can read.
Team plan Enterprise plan
If all you want is for an AI tool such as Claude or ChatGPT to consult your notes, the MCP server suits better. MCP uses OAuth in a browser and is designed for interactive AI tools. Use API keys for scripts, scheduled automation, and calls from your own systems.
What you can build
- Your own AI agents — build your own processing to aggregate trends across sales meetings, extract recurring themes from product requests, or combine meeting context with other internal data.
- Internal knowledge bases and wikis — feed meeting notes into Notion, Confluence or an internal wiki and keep them searchable and current.
- Task and follow-up automation — extract decisions and tasks from notes and create them automatically in Linear, Jira, Todoist and similar.
- CRM updates and reporting — send meeting summaries and tasks to CRM records, dashboards and internal reporting.
Plans that include it
API keys can be created by workspace members on the Team or Enterprise plan.
On the Enterprise plan, administrators can control the scopes members are allowed under Settings → Workspace → General → API access for members.
The plan names are provisional within this help centre. Adjust them to match UNCHAIN, Inc.'s actual plans.
Access scopes
An API key specifies the range of notes it can read.
| Scope | Notes it can read |
|---|---|
| Personal notes | notes you own / notes shared directly with you / notes in private folders shared with you |
| Public notes | notes everyone in the workspace can see / notes in the team space |
Pulse notes are private by default. To make a note readable under the public notes scope, it has to be in a folder everyone in the workspace can see, such as a folder in the team space. A note left in a private folder can be read only under the personal notes scope of a user who could already access it.
Creating a personal API key
- to be a workspace member on the Team or Enterprise plan
- the Pulse desktop app (macOS / Windows). Keys are issued from the desktop app
- on the Enterprise plan, that an administrator has enabled the relevant scope
Open the API keys screen in settings
In the desktop app, open Settings → Connectors → API keys.
Create a new key
Click “Create new key” and choose the scopes to include in it.
Generate and copy the key
Click “Generate API Key”, copy the key shown, and register it in the system that will use it.
The list of issued keys (name, scope, creation date, revoke button) and the button for creating a new one.
- the key you created appears in the list under Settings → Connectors → API keys with the scope you expected
- with the key registered in your system, it retrieves the notes you can see in Pulse
An API key is a credential that can read every note and transcript within its scope. Do not paste it directly into source code, chat tools, issue trackers or shared documents. Store it using environment variables or a secrets manager, and take care not to commit it to a repository. If there is any possibility a third party has seen it, revoke that key immediately regardless and issue a new one.
On the Enterprise plan you cannot create a key with a scope an administrator has not enabled. If the scope you want is not offered on the creation screen, check with your workspace administrator.
Administrators controlling scopes (Enterprise plan)
- Settings → Workspace → General.
- API access for members.
- Click “Manage”.
- Choose the scopes members may use.
There are four options: personal notes only, public notes only, both, or neither. Setting it to neither means members cannot create new API keys.
Workspace API keys
A workspace API key is managed by administrators and belongs to the workspace rather than an individual. It is available on the Team and Enterprise plans. Unlike a personal API key it does not expire and is not tied to a particular person's account, so it keeps working after the administrator who created it leaves. It suits uses where a departure must not break things, such as a permanent integration with a core system.
A workspace API key can read the following.
- Public notes — notes everyone in the workspace can see, such as those in the team space. If an administrator has switched the workspace's allow public folders setting off, these notes are not exposed to the API.
- Notes in spaces with API access enabled — switching “Allow API access” on when creating a space, or afterwards under Settings → Spaces, makes that space's notes readable with a workspace API key. That includes folders and subfolders under the space.
Private notes and folders falling under neither of these cannot be read with a workspace API key.
“Allow API access” is enabled by default when you create a new space. If you do not want that space's notes readable with a workspace API key, switch it off at creation or afterwards under Settings → Spaces.
Only workspace administrators can create and manage workspace API keys. The steps are as follows.
Open the workspace API keys screen in settings
In the desktop app, open Settings → Connectors → Workspace API keys.
Create a new key
Click “Create new key”.
Copy the key and register it
Copy the API key shown and register it in the system that will use it.
Revoking a key
Personal and workspace API keys are managed on separate pages, so revoke each from its own page.
Revoking a personal API key
- Settings → Connectors → API keys.
- Find the key you want to revoke and click “Revoke”.
- Confirm in the dialog.
Revoking a workspace API key (administrators only)
- Settings → Connectors → Workspace API keys.
- Find the key you want to revoke and click “Revoke”.
- Confirm in the dialog.
A revoked key is permanently invalid and moves to the “Revoked” section of the list. It cannot be restored. Integrations using it stop working, so check which systems use the key before revoking it.
API reference
The reference covering endpoints, authentication, and example requests and responses is published in the developer documentation. For the terms on which the API and integrations may be used, see the API and platform terms of service.
Replace the published URLs of the API reference and the webhook guide with the actual locations on the-unchain.com.
About the data involved
What the API retrieves is meeting notes and transcripts, which normally contain personal data such as attendees' names, email addresses and what they said. If you store retrieved data in your own systems, design where it is stored, how long it is kept, and who can access it in line with your own personal data handling rules.
For how to account for passing retrieved data on to another provider, see Integrations overview.
Frequently asked questions
Q. Which plan do I need?
A. Creating API keys requires the Team or Enterprise plan.
Q. How does the API differ from MCP?
A. The API issues API keys for scripts, scheduled automation and calls from your own systems. MCP uses OAuth in a browser and is designed for interactive AI tools such as Claude and ChatGPT.
Q. Can it access private notes and private folders?
A. Only where the key includes the personal notes scope and the key's owner could already see that note in Pulse. The public notes scope covers only notes everyone in the workspace can see.
Q. Can one key retrieve both the team's notes and my own?
A. Yes. Select both “personal notes” and “public notes” when creating the key.
Q. The API returns no notes at all
A. The API returns only notes matching the key's scope. If you are using the public notes scope, check the notes are in a folder visible to everyone in the workspace, such as one in the team space. If you are using the personal notes scope, check the key's owner can open those notes in Pulse.
Q. Is there a sandbox for testing?
A. Not at this time. We suggest creating a test folder and checking the behaviour against a small number of notes.
Q. Are there rate limits?
A. Yes. API keys are limited to 25 requests in a burst and 5 requests per second sustained. Whether the limit applies per user or per workspace depends on the key's scope.
Q. Are webhooks available?
A. Yes, on the Team and Enterprise plans. For registering endpoints, choosing which events to subscribe to, verifying signatures and handling retries, see the webhook guide in the developer documentation.