Skip to main content

TurboDocx Ruby SDK

Agent Skill

Let an agent scaffold this for you

Install the TurboDocx Quickstart Skill and let Claude Code, Cursor, Copilot, Codex, or any agent that speaks the Agent Skills standard install the SDK, wire it into your app, and write a working TurboSign integration end-to-end.

Skill countView on GitHubFull install guide →
bash — turbodocx
$npx skills add TurboDocx/quickstart
# then, inside your agent:›/turbodocx-sdk turbosign

The official TurboDocx SDK for Ruby applications. Build document generation and digital signature workflows with a simple synchronous API and comprehensive error handling. Available on RubyGems as turbodocx-sdk.

Installation​

gem install turbodocx-sdk

Requirements​

  • Ruby 2.7+
  • No runtime dependencies (uses the standard library's net/http)

Configuration​

require "turbodocx_sdk"

# Configure globally (recommended)
TurboDocxSdk::TurboSign.configure(
  api_key:      ENV["TURBODOCX_API_KEY"],   # Required: Your TurboDocx API key
  org_id:       ENV["TURBODOCX_ORG_ID"],    # Required: Your organization ID
  sender_email: "contracts@yourcompany.com", # Required: Reply-to address for signature emails
  sender_name:  "Your Company"               # Recommended: Sender name shown in emails
  # base_url:   "https://api.turbodocx.com"  # Optional: Override base URL
)
Authentication

Authenticate using api_key. API keys are recommended for server-side applications.

Environment Variables​

# .env
TURBODOCX_API_KEY=your_api_key_here
TURBODOCX_ORG_ID=your_org_id_here
TURBODOCX_SENDER_EMAIL=contracts@yourcompany.com
TURBODOCX_SENDER_NAME=Your Company
API Credentials Required

api_key and org_id are required for all API requests. TurboSign additionally requires sender_email (set it on configure, per call, or via the TURBODOCX_SENDER_EMAIL environment variable): configure raises a TurboDocxSdk::ValidationError without it. sender_name is optional but strongly recommended. To get your credentials, follow the Get Your Credentials steps from the SDKs main page.

Product guides​

Each product guide opens on the Ruby tab:

  • TurboSign: send documents for signature, track status, download signed PDFs and audit trails
  • Deliverable: generate documents from templates
  • TurboWebhooks: receive real-time signature events
  • TurboQuote: create, send and download quotes

Resources​

Last updated on