Request API access

Direct workspace API access is available to selected workspaces through a private pilot. It is not unlocked automatically by a plan. A workspace owner must request access from Support.

Good API use cases

Request access when a real workflow needs to:

• upload generated documents automatically;
• publish HTML output from an internal system;
• create personalized Share Links from a CRM or sales workflow;
• find or create companies and contacts;
• retrieve engagement events for an approved integration.

For a small number of manual uploads, the Document Library is simpler and safer than maintaining an API integration.

Request access

Open a Support ticket from the workspace and include:

• the workflow you want to automate;
• expected upload or request volume;
• the file types involved;
• whether you need companies, contacts, shares, views, or events;
• the owner who will manage the credential.

Support will review the use case and confirm whether the workspace can join the pilot.

Create the workspace token

After approval, the workspace owner can open Workspace, choose Integrations, and find HummingDeck API.

The token is shown once. Store it in a secret manager. Do not paste it into browser code, an HTML upload, a public repository, a shared document, or a support ticket.

Creating a new token replaces the previous token immediately. Switching a token off is permanent for that token. Workspace tokens expire after one year.

Read the API reference

The existing HummingDeck API reference covers authentication, document uploads, Share Links, companies, contacts, views, events, and webhooks.

Browser uploads accept files up to 100 MB. The API document upload endpoint has a 30 MB limit. HTML uploaded through the API must still meet the same static-content and asset requirements as a manual upload.