Skip to main content
formable is the official Ruby SDK for the Formable API (v1). It covers templates, signature requests, redlining, and billing.
  • Faraday HTTP client (injectable)
  • Keyword arguments and snake_case method names
  • Ruby 3.1+
Source code is on GitHub.

Installation

Initialize the client

Pass your API key from Settings. It’s sent as a bearer token on every request.

Templates

Upload a document to create a reusable template, then mint edit URLs to place fields in the embedded editor. See the embedded templates walkthrough. file accepts a path, binary string, or IO. Pass filename: when file is not a path.

Signature requests

Send a template for signing by email, or embed the signing experience in your product. See the embedded signing walkthrough.
get_signed_envelope raises a 409 until the document is complete. Wait for the document_completed webhook, or poll get until status is Completed.

Redline requests

Run turn-based contract negotiation before signing. See the redlining walkthrough.

Billing and health

Error handling

All non-2xx responses raise a Formable::Error with the server’s error message, HTTP status, and parsed response body.

Configuration

The client takes an API key, then optional base_url, timeout, and Faraday connection arguments.
Request hashes accept snake_case keys (template_id, display_name, field_id). Responses use the API’s camelCase field names (templateId, displayName).

Next steps

Quickstart

Go from a plain document to a signed PDF in 4 calls.

API reference

Every endpoint the SDK wraps, with a live playground.