Deliverable PHP 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 Deliverable integration end-to-end.

View on GitHubFull install guide →

bash — turbodocx

$npx skills add TurboDocx/quickstart

# then, inside your agent:›/turbodocx-sdk deliverable

The official TurboDocx Deliverable SDK for PHP applications. Generate documents from templates with dynamic variable injection, download source files and PDFs, and manage deliverables programmatically. Available on Packagist as turbodocx/sdk.

Installation

composer require turbodocx/sdk

Requirements

• PHP 8.1 or higher
• Composer
• ext-json
• ext-fileinfo

Modern PHP Features

This SDK leverages PHP 8.1+ features including enums, named parameters, readonly classes, and match expressions for a superior developer experience.

---

Configuration

Manual Configuration

<?php

use TurboDocx\Deliverable;
use TurboDocx\Config\DeliverableConfig;

// Configure with all options
Deliverable::configure(new DeliverableConfig(
    apiKey: $_ENV['TURBODOCX_API_KEY'],   // Required: Your TurboDocx API key
    orgId: $_ENV['TURBODOCX_ORG_ID'],     // Required: Your organization ID
    baseUrl: 'https://api.turbodocx.com'  // Optional: Custom API endpoint
));

From Environment

<?php

use TurboDocx\Deliverable;
use TurboDocx\Config\DeliverableConfig;

// Auto-configure from environment variables
Deliverable::configure(DeliverableConfig::fromEnvironment());

// Reads from: TURBODOCX_API_KEY, TURBODOCX_ORG_ID

No senderEmail Required

Unlike TurboSign, the Deliverable module only requires apiKey and orgId: no sender email or name is needed.

Environment Variables

# .env
TURBODOCX_API_KEY=your_api_key_here
TURBODOCX_ORG_ID=your_org_id_here

API Credentials Required

An apiKey (or accessToken as an alternative) is required for all API requests; orgId is optional but recommended for organization-scoped operations. To get your credentials, follow the Get Your Credentials steps from the SDKs main page.

---

Quick Start

Generate a document from a template

<?php

use TurboDocx\Deliverable;
use TurboDocx\Config\DeliverableConfig;

Deliverable::configure(DeliverableConfig::fromEnvironment());

// Generate a document from a template with variables
$result = Deliverable::generateDeliverable([
    'name' => 'Q1 Report',
    'templateId' => 'your-template-id',
    'variables' => [
        ['placeholder' => '{CompanyName}', 'text' => 'Acme Corporation', 'mimeType' => 'text'],
        ['placeholder' => '{Date}', 'text' => '2026-03-12', 'mimeType' => 'text'],
    ],
    'description' => 'Quarterly business report',
    'tags' => ['reports', 'quarterly'],
]);

echo "Deliverable ID: {$result['results']['deliverable']['id']}\n";

Always Handle Errors

The above examples omit error handling for brevity. In production, wrap all Deliverable calls in try-catch blocks. See Error Handling for complete patterns.

Download and manage deliverables

<?php

use TurboDocx\Deliverable;

// List deliverables with pagination
$list = Deliverable::listDeliverables(['limit' => 10, 'showTags' => true]);
echo "Total: {$list['totalRecords']}\n";

// Get deliverable details
$details = Deliverable::getDeliverableDetails('deliverable-uuid', showTags: true);
echo "Name: {$details['name']}\n";

// Download source file (DOCX/PPTX)
$sourceFile = Deliverable::downloadSourceFile('deliverable-uuid');
file_put_contents('report.docx', $sourceFile);

// Download PDF
$pdfFile = Deliverable::downloadPDF('deliverable-uuid');
file_put_contents('report.pdf', $pdfFile);

// Update deliverable
$updated = Deliverable::updateDeliverableInfo('deliverable-uuid', [
    'name' => 'Q1 Report - Final',
    'description' => 'Final quarterly business report',
]);

// Delete deliverable
$deleted = Deliverable::deleteDeliverable('deliverable-uuid');

Always Handle Errors

The above examples omit error handling for brevity. In production, wrap all Deliverable calls in try-catch blocks. See Error Handling for complete patterns.

---

Variable Types

The Deliverable module supports four variable types for template injection:

1. Text Variables

Inject plain text values into template placeholders:

$variables = [
    ['placeholder' => '{CompanyName}', 'text' => 'Acme Corporation', 'mimeType' => 'text'],
    ['placeholder' => '{Date}', 'text' => '2026-03-12', 'mimeType' => 'text'],
];

2. HTML Variables

Inject rich HTML content with formatting:

$variables = [
    [
        'placeholder' => '{Summary}',
        'text' => '<p>This is a <strong>formatted</strong> summary with <em>rich text</em>.</p>',
        'mimeType' => 'html',
    ],
];

3. Image Variables

Inject images by providing a URL or base64-encoded content:

$variables = [
    [
        'placeholder' => '{Logo}',
        'text' => 'https://example.com/logo.png',
        'mimeType' => 'image',
    ],
];

4. Markdown Variables

Inject markdown content that gets converted to formatted text:

$variables = [
    [
        'placeholder' => '{Notes}',
        'text' => "## Key Points\n- First item\n- Second item\n\n**Important:** Review before submission.",
        'mimeType' => 'markdown',
    ],
];

Variable Stack

For repeating content (e.g., table rows), use variableStack instead of text to provide multiple values for the same placeholder. See the PHP Types section for details.

---

API Reference

Configure

Configure the SDK with your API credentials and organization settings.

use TurboDocx\Deliverable;
use TurboDocx\Config\DeliverableConfig;

// Manual configuration
Deliverable::configure(new DeliverableConfig(
    apiKey: 'your-api-key',
    orgId: 'your-org-id'
));

// Or from environment
Deliverable::configure(DeliverableConfig::fromEnvironment());

Generate deliverable

Generate a new document from a template with variable substitution.

$result = Deliverable::generateDeliverable([
    'name' => 'Q1 Report',
    'templateId' => 'your-template-id',
    'variables' => [
        ['placeholder' => '{CompanyName}', 'text' => 'Acme Corp', 'mimeType' => 'text'],
        ['placeholder' => '{Date}', 'text' => '2026-03-12', 'mimeType' => 'text'],
    ],
    'description' => 'Quarterly business report',
    'tags' => ['reports', 'quarterly'],
]);

echo "Deliverable ID: {$result['results']['deliverable']['id']}\n";

List deliverables

List deliverables with pagination, search, and filtering.

$list = Deliverable::listDeliverables([
    'limit' => 10,
    'offset' => 0,
    'query' => 'report',
    'showTags' => true,
]);

echo "Total records: {$list['totalRecords']}\n";
foreach ($list['results'] as $deliverable) {
    echo "  {$deliverable['name']}\n";
}

Get deliverable details

Retrieve the full details of a single deliverable, including variables and fonts.

$details = Deliverable::getDeliverableDetails('deliverable-uuid', showTags: true);

echo "Name: {$details['name']}\n";
echo "Template: {$details['templateName']}\n";
echo "Created: {$details['createdOn']}\n";

Update deliverable info

Update a deliverable's name, description, or tags.

$result = Deliverable::updateDeliverableInfo('deliverable-uuid', [
    'name' => 'Q1 Report - Final',
    'description' => 'Final quarterly business report',
    'tags' => ['reports', 'final'],
]);

echo "Updated: {$result['deliverableId']}\n";

Delete deliverable

Soft-delete a deliverable.

$result = Deliverable::deleteDeliverable('deliverable-uuid');

echo "Deleted: {$result['deliverableId']}\n";
echo "Message: {$result['message']}\n";

Download source file

Download the original source file (DOCX or PPTX).

$sourceFile = Deliverable::downloadSourceFile('deliverable-uuid');

// Save to file
file_put_contents('report.docx', $sourceFile);

// Or send as HTTP response
header('Content-Type: application/vnd.openxmlformats-officedocument.wordprocessingml.document');
header('Content-Disposition: attachment; filename="report.docx"');
echo $sourceFile;

Download PDF

Download the PDF version of a deliverable.

$pdfFile = Deliverable::downloadPDF('deliverable-uuid');

// Save to file
file_put_contents('report.pdf', $pdfFile);

// Or send as HTTP response
header('Content-Type: application/pdf');
header('Content-Disposition: attachment; filename="report.pdf"');
echo $pdfFile;

---

Error Handling

Deliverable::generateDeliverable() throws NotFoundException when templateId doesn't match a template in the org, and ValidationException when a variable in the variables array is missing a required field:

Handling Errors

<?php

use TurboDocx\Deliverable;
use TurboDocx\Exceptions\TurboDocxException;
use TurboDocx\Exceptions\AuthenticationException;
use TurboDocx\Exceptions\AuthorizationException;
use TurboDocx\Exceptions\ValidationException;
use TurboDocx\Exceptions\NotFoundException;
use TurboDocx\Exceptions\ConflictException;
use TurboDocx\Exceptions\RateLimitException;
use TurboDocx\Exceptions\NetworkException;

try {
    $result = Deliverable::generateDeliverable([
        'name' => 'Q1 Report',
        'templateId' => 'your-template-id',
        'variables' => [
            ['placeholder' => '{CompanyName}', 'text' => 'Acme Corp', 'mimeType' => 'text'],
        ],
    ]);
} catch (AuthenticationException $e) {
    // 401 - Invalid API key or access token
    echo "Authentication failed: {$e->getMessage()}\n";
} catch (AuthorizationException $e) {
    // 403 - API key lacks required permissions
    echo "Authorization error: {$e->getMessage()}\n";
} catch (ValidationException $e) {
    // 400 - Invalid request data
    echo "Validation error: {$e->getMessage()}\n";
} catch (NotFoundException $e) {
    // 404 - Deliverable or template not found
    echo "Not found: {$e->getMessage()}\n";
} catch (ConflictException $e) {
    // 409 - Resource conflict
    echo "Conflict: {$e->getMessage()}\n";
} catch (RateLimitException $e) {
    // 429 - Rate limit exceeded
    echo "Rate limit: {$e->getMessage()}\n";
} catch (NetworkException $e) {
    // Network/connection error
    echo "Network error: {$e->getMessage()}\n";
}

The full typed-exception table (AuthenticationException, AuthorizationException, ConflictException, RateLimitException, NetworkException, HTTP status mapping) and the getMessage()/statusCode/errorCode properties shared by every exception are documented once in the PHP SDK's Error Handling reference.

---

PHP Types

Variable Array Structure

Variables are passed as associative arrays with the following keys:

Key	Type	Required	Description
placeholder	string	Yes	Template placeholder (e.g., {CompanyName})
text	string	No*	Value to inject
mimeType	string	Yes	"text", "html", "image", or "markdown"
isDisabled	bool	No	Skip this variable during generation
allowRichTextInjection	bool	No	Whether to allow rich text injection
subvariables	array	No	Nested sub-variables for HTML content
variableStack	array	No	Multiple instances for repeating content
aiPrompt	string	No	AI prompt for content generation (max 16,000 chars)

*Required unless variableStack is provided or isDisabled is true.

Generate Deliverable Request

Request array for generateDeliverable:

Key	Type	Required	Description
name	string	Yes	Deliverable name (3-255 characters)
templateId	string	Yes	Template ID to generate from
variables	array	Yes	Variables for template substitution
description	string	No	Description (up to 65,535 characters)
tags	array	No	Tag strings to associate

Update Deliverable Request

Request array for updateDeliverableInfo:

Key	Type	Required	Description
name	string	No	Updated name (3-255 characters)
description	string	No	Updated description
tags	array	No	Replace all tags (empty array to remove)

List Deliverables Options

Options array for listDeliverables:

Key	Type	Required	Description
limit	int	No	Results per page (1-100, default 6)
offset	int	No	Results to skip (default 0)
query	string	No	Search query to filter by name
showTags	bool	No	Include tags in the response

Deliverable Record

The deliverable record returned by listDeliverables:

Key	Type	Description
id	string	Unique deliverable ID (UUID)
name	string	Deliverable name
description	string	Description text
templateId	string	Source template ID
createdBy	string	User ID of the creator
email	string	Creator's email address
fileSize	int	File size in bytes
fileType	string	MIME type of the generated file
defaultFont	string	Default font used
fonts	array	Fonts used in the document
isActive	bool	Whether the deliverable is active
createdOn	string	ISO 8601 creation timestamp
updatedOn	string	ISO 8601 last update timestamp
tags	array	Associated tags (when showTags=true)

Deliverable Detail Record

The deliverable record returned by getDeliverableDetails. Includes all fields from Deliverable Record except fileSize, plus:

Key	Type	Description
templateName	string	Source template name
templateNotDeleted	bool	Whether the source template still exists
variables	array	Parsed variable objects with values

Tag

Tag object included when showTags is enabled. Each tag is an associative array with:

Key	Type	Description
id	string	Tag unique identifier (UUID)
label	string	Tag display name
isActive	bool	Whether the tag is active
updatedOn	string	ISO 8601 last update timestamp
createdOn	string	ISO 8601 creation timestamp
createdBy	string	User ID of the tag creator
orgId	string	Organization ID

---

Additional Documentation

For detailed information about advanced configuration and API concepts, see:

Core API References

• TurboDocx Templating - How to create and configure document templates
• Variable Reference - Complete guide to variable types, formatting, and advanced injection options
• API Reference - Full REST API documentation for Deliverable endpoints

---

Resources

• GitHub Repository
• Packagist Package
• API Reference