Install and configure Documenso SDK/API authentication.
Use when setting up a new Documenso integration, configuring API keys,
or initializing Documenso in your project.
Trigger with phrases like "install documenso", "setup documenso",
"documenso auth", "configure documenso API key".
Set up the Documenso SDK and configure API authentication for document signing. Covers the TypeScript SDK (@documenso/sdk-typescript), the Python SDK (documenso-sdk-python), and raw REST API usage. Documenso exposes two API versions: v1 (legacy, documents only) and v2 (envelopes, multi-document, recommended for new work).
Prerequisites
Node.js 18+ or Python 3.10+
Package manager (npm, pnpm, yarn, pip, or uv)
Documenso account — cloud at app.documenso.com or self-hosted instance
API key generated from the Documenso dashboard
Instructions
Step 1: Install the SDK
TypeScript / Node.js:
npm install @documenso/sdk-typescript
# or
pnpm add @documenso/sdk-typescript
Python:
pip install documenso-sdk-python
# or
uv pip install documenso-sdk-python
Step 2: Generate an API Key
Log in to your Documenso dashboard (https://app.documenso.com or your self-hosted URL).
Click your avatar (top-right) and select User settings (or Team settings for team-scoped keys).
Navigate to the API tokens tab.
Click Create API Key, give it a descriptive name (e.g. ci-pipeline-prod).
Copy the key immediately — it is shown only once.
Team API keys inherit the team's document and template access. Personal keys only access your own documents.
Step 3: Store the Key Securely
# .env (never commit this file)
DOCUMENSO_API_KEY=api_xxxxxxxxxxxxxxxxxxxxxxxxxx
Add .env to .gitignore:
echo ".env" >> .gitignore
Step 4: Initialize the Client
TypeScript — v2 API (recommended):
import { Documenso } from "@documenso/sdk-typescript";
const documenso = new Documenso({
apiKey: process.env.DOCUMENSO_API_KEY!,
// For self-hosted, override the server URL:
// serverURL: "https://sign.yourcompany.com/api/v2",
});