LogTalk API

Transform your changelogs into engaging audio and video content programmatically. Perfect for CI/CD integration with GitHub Actions, GitLab CI, and more.

Base URL

All API requests should be made to the following base URL:

https://logtalk.io/api/v1

Endpoints

The LogTalk API provides the following endpoints:

MethodEndpointDescription
Conversions
POST/conversionsCreate a conversion (changelog or document)
GET/conversionsList all conversions
GET/conversions/{id}Get conversion details / poll status
PATCH/conversions/{id}Update conversion metadata
DELETE/conversions/{id}Delete a conversion
POST/conversions/{id}/retryRetry a failed conversion
GET/conversions/{id}/audioGet signed audio URL
POST/conversions/{id}/embed-tokenCreate an embed token
DocTalk (Deprecated)
POST/doctalk/convertConvert document to audio
GET/doctalk/convert/{id}Get conversion status
GET/doctalk/convert/{id}/audioDownload audio
Episodes (Deprecated)
POST/episodesCreate episode — use /conversions instead
GET/episodes/{id}Get episode — use /conversions instead
Scripts
POST/scriptsGenerate a script for preview
POST/scripts/{id}/convertConvert a script to audio
Metadata
GET/usageGet usage statistics
GET/changelogsList changelogs for context

Quick Start

Get your first audio episode in under 5 minutes:

1

Create an API Key

Go to Settings → API Keys to create your first API key. API access requires a Growth tier subscription or higher.

2

Make Your First Request

Use the cURL command below to convert a changelog to audio:

First API Request
curl -X POST https://logtalk.io/api/v1/conversions \
-H "Authorization: Bearer lt_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"source_type": "changelog",
"title": "MyApp v2.0.0 Release",
"content": "## v2.0.0 - New Features\n- Added dark mode support\n- Improved performance by 40%",
"settings": {
"product_name": "MyApp",
"version": "2.0.0",
"tone": "casual"
},
"wait": true
}'
3

Get Your Audio

Audio episodes are processed synchronously. The response includes a URL to download your audio file.

Response
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"source_type": "changelog",
"title": "MyApp v2.0.0 Release",
"status": "completed",
"has_audio": true,
"audio_url": "https://logtalk.io/api/v1/conversions/550e8400.../audio",
"generated_script": "[NARRATOR]: Welcome to MyApp version 2.0...",
"duration_seconds": 45,
"completed_at": "2026-01-18T14:30:00.000Z",
"created_at": "2026-01-18T14:29:30.000Z"
},
"request_id": "req_1kn5f2a_a3b4c5d6e7f8",
"timestamp": "2026-01-18T14:30:00.000Z"
}

Key Features

Fast Audio Generation
Audio episodes complete in under 30 seconds. Perfect for real-time CI/CD pipelines.
Async Generation
Long-running jobs return immediately with a conversion ID. Poll for status or receive webhooks on completion.
Idempotent Requests
Use idempotency keys to safely retry failed requests without creating duplicates.
Webhook Notifications
Get notified instantly when episodes complete via secure webhook callbacks.

API Access Requirements

API access is available on Growth tier and above. Rate limits vary by subscription:

TierDaily LimitPer-MinuteConcurrent
Growth100 requests20 requests3 jobs
Pro500 requests60 requests10 jobs
Team2,000 requests200 requests25 jobs

Next Steps

  • Authentication - Learn about API key formats and security best practices
  • Conversions API - Full reference for creating and managing conversions
  • DocTalk API - Convert any text content to audio (Preview)
  • Webhooks - Set up real-time notifications for your integrations
  • CI/CD Examples - Ready-to-use examples for GitHub Actions, GitLab CI, and more