TranscriptDock 0.1.0

dotnet add package TranscriptDock --version 0.1.0
                    
NuGet\Install-Package TranscriptDock -Version 0.1.0
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="TranscriptDock" Version="0.1.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="TranscriptDock" Version="0.1.0" />
                    
Directory.Packages.props
<PackageReference Include="TranscriptDock" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add TranscriptDock --version 0.1.0
                    
#r "nuget: TranscriptDock, 0.1.0"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package TranscriptDock@0.1.0
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=TranscriptDock&version=0.1.0
                    
Install as a Cake Addin
#tool nuget:?package=TranscriptDock&version=0.1.0
                    
Install as a Cake Tool

Transcript Dock for .NET

An asynchronous client for the public Transcript Dock API. Targets .NET 8 and newer, with no third party runtime dependencies. Version 0.1.0.

using TranscriptDock;

using var client = new TranscriptDockClient(Environment.GetEnvironmentVariable("TRANSCRIPTDOCK_API_KEY")!);
// Generate once per intended submission and save it with the returned job ID.
var key = Guid.NewGuid().ToString();
var job = await client.CreateJobAsync(new {
    source = new { url = "https://www.youtube.com/watch?v=dQw4w9WgXcQ" },
    mode = "captions_only", max_credits = 1
}, key);
job = await client.WaitForJobAsync(job.GetProperty("id").GetString()!);
if (job.GetProperty("status").GetString() == "succeeded") {
    var text = await client.ExportTranscriptAsync(job.GetProperty("result_id").GetString()!, "txt");
    Console.WriteLine(text);
}

Creating jobs can spend credits. The example caps captions at one credit and does not enable AI fallback. Reuse the exact request body and saved idempotency key to recover a lost submission response. There are no automatic retries.

CapabilitiesAsync, CreateJobAsync, GetJobAsync, GetTranscriptAsync, ExportTranscriptAsync and WaitForJobAsync cover the core flow. RequestAsync(method, path, body, query, idempotencyKey, cancellationToken) covers all public /v1 endpoints using the exact API fields, including batches, discovery, uploads, usage and webhooks. See the API contract.

JSON responses are cloned JsonElement objects retaining every field and the original timing units. Export methods return raw text, including JSON exports. Polling returns failed and cancelled jobs normally; inspect status first. JobTimeoutException.Job retains the last observed job. Caller cancellation propagates as OperationCanceledException. Dispose the client when finished.

The default request timeout is 30 seconds. Custom origins require HTTPS, except loopback HTTP development. Redirects are blocked to protect the API key. ApiException exposes Code, Status, Retryable, RequestId and RetryAfterSeconds. Messages redact bearer tokens and do not expose gateway HTML.

Signed upload URLs are used separately without the API key. Webhook secrets must stay private; implement receiver signature checks from the API docs.

Local checks and package build

From the application repository root with Python 3 and .NET SDK 8 or newer installed:

dotnet restore TranscriptDock.Checks --locked-mode
python3 .ci/check.py
dotnet pack TranscriptDock -c Release -o artifacts

The library targets .NET 8; the local check executable also uses .NET 8. Tests call a loopback fixture, never production. Lockfiles contain no third party packages. Release workflow: https://github.com/TranscriptDock/transcriptdock-dotnet/actions.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
  • net8.0

    • No dependencies.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.1.0 94 11/15/2026