Intelligence

Outline

View Markdown

Overview

The outline task generates structured chapter markers for timed media using AI. Unlike the chapters task which produces subtitle files, the outline task produces a JSON output with start/end times and titles for each section.


Creating an outline task

curl -X POST "https://api.ittybit.com/tasks" \
-H "Authorization: Bearer ITTYBIT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
  "url": "https://example.com/video.mp4",
  "kind": "outline"
}'

The outline task has no configurable options.


Output

When the task succeeds, the output JSON file contains a timeline of sections:

{
  "kind": "outline",
  "timeline": [
    {
      "title": "Introduction",
      "start": 0,
      "end": 45.2
    },
    {
      "title": "Main Topic Discussion",
      "start": 45.2,
      "end": 180.5
    },
    {
      "title": "Conclusion",
      "start": 180.5,
      "end": 240.0
    }
  ]
}
FieldTypeDescription
timelinearrayArray of section markers
timeline[].titlestringTitle of the section
timeline[].startnumberStart time in seconds
timeline[].endnumberEnd time in seconds

Supported inputs

  • Audio files: .mp3, .m4a, .wav, .ogg, .aac, .flac
  • Video files with audio: .mp4, .mov, .webm

Common use cases

  • Generating table-of-contents data for video libraries
  • Building interactive video navigation UIs
  • Structuring podcast episodes for show notes
  • Creating chapter metadata for media catalogs

Chapters

Summary

On this page