PodcastIncAI

RESTful API Documentation

PodcastInc API Reference

Integrate podcast processing, transcription, content generation, and video tools into your applications with our powerful RESTful API.

Quick Start Guide

1. Get API Key

2. Make Request

Include your API key in the X-API-KEY header

3. Start Building

Access all features via our RESTful endpoints

Authentication Example

bash

# Include your API key in the X-API-KEY header
curl -X GET "https://api.podcastinc.io/api/v1/projects" \
  -H "X-API-KEY: pak_your_api_key_here" \
  -H "Accept: application/json"

API Scopes

Control access with granular permission scopes

Projects: Read

List projects, inspect metadata, analytics, media and download links

projects.read

Projects: Manage

Upload new media, regenerate chapters, translate transcripts

projects.write

Projects: Delete

Delete projects and associated assets

projects.delete

Transcriptions: Read

Retrieve transcript data and export files

transcriptions.read

Transcriptions: Manage

Retry transcription jobs and run translation workflows

transcriptions.write

Social Media: Read

List generated social posts and retrieve details

socialMedia.read

Social Media: Manage

Generate, update, or delete social media content

socialMedia.write

Long-form: Read

View long-form content drafts and metadata

longForm.read

Long-form: Manage

Generate, update, or delete long-form content

longForm.write

Show Notes: Read

Retrieve generated show notes and summaries

showNotes.read

Show Notes: Manage

Generate, update, or delete show notes

showNotes.write

Video: Read

Access video processing history, clip metadata, and AI timestamps

video.read

Video: Generate Clips

Process video clips and AI video outputs

video.generate

Video: Captioning

Run captioning workflows and manage caption assets

video.caption

Video: Download

Download processed video outputs and assets

video.download

Scope-Based Access Control

Each API key can be assigned specific scopes. Requests lacking required scopes will return a 403 Forbidden error. Contact your administrator to update key permissions.

Available Endpoints

Complete list of API endpoints organized by category

Projects

POST/api/v1/projects/upload

Upload a new podcast file for processing

projects.write

GET/api/v1/projects

List all your projects with pagination

projects.read

GET/api/v1/projects/{id}

Get detailed information about a specific project

projects.read

DELETE/api/v1/projects/{id}

Delete a project and all associated assets

projects.delete

Transcriptions

GET/api/v1/projects/{id}/transcription

Retrieve transcription data for a project

transcriptions.read

GET/api/v1/projects/{id}/export/{format}

Export transcription in various formats (txt, srt, vtt, json)

transcriptions.read

POST/api/v1/projects/{id}/retry

Retry transcription for a failed project

transcriptions.write

Social Media

GET/api/v1/social-media

Get AI-generated social media posts

socialMedia.read

POST/api/v1/social-media/generate

Generate new social media posts for a project

socialMedia.write

Long-Form Content

GET/api/v1/long-form

Retrieve long-form content (blogs, articles)

longForm.read

POST/api/v1/long-form/generate

Generate long-form content for a project

longForm.write

Show Notes

GET/api/v1/show-notes

Retrieve generated show notes

showNotes.read

POST/api/v1/show-notes/generate

Generate show notes for a project

showNotes.write

Video Processing

GET/api/v1/video-processing

List video processing jobs

video.read

POST/api/v1/video-processing/generate

Generate AI video clips from your podcast

video.generate

POST/api/v1/video-processing/captions

Generate captions for video content

video.caption

GET/api/v1/video-processing/{id}/download

Download processed video content

video.download

Code Examples

Common use cases and request examples

Upload a Podcast File

bash

# Upload a podcast file
curl -X POST "https://api.podcastinc.io/api/v1/projects/upload" \
  -H "X-API-KEY: pak_your_api_key_here" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@podcast-episode.mp3" \
  -F "title=My Awesome Episode"

List All Projects

bash

# List all projects
curl -X GET "https://api.podcastinc.io/api/v1/projects?page=1&limit=20" \
  -H "X-API-KEY: pak_your_api_key_here" \
  -H "Accept: application/json"

Get Transcription

bash

# Get transcription for a project
curl -X GET "https://api.podcastinc.io/api/v1/projects/{projectId}/transcription" \
  -H "X-API-KEY: pak_your_api_key_here" \
  -H "Accept: application/json"

Ready to Start Building?

Create your account to get instant access to your API keys and start integrating PodcastInc into your applications today.

Need More Details?

Questions?

Our support team is here to help you integrate successfully

See It in Action

Explore our platform features before diving into API integration