dimenshon

Log InSign UpAPI Documentation

API Documentation

Automate your video post production content processes even further by simply sending your video's url to our API. We'll take care of the rest.

Table of Contents

Authentication Headers

Authenticating your request to use the dimenshon API is very easy. Your requests need the following header with your API key as the value.

If you do not have an API key, generate one now.

x-dimenshon-key: 0e20b0d1-5e26-4b9e-979f-5b3702ced9dc

Podcasts

A podcast can be treated like a channel, a series, podcast, or show.

Each podcast in dimenshon has it's own RSS feed to be shared to other platforms like Spotify or iTunes.

Schema

{
    _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
    title: 'Title of this podcast',
    thumbnail: 'url to image',
    description: 'lorem ipsom sier die',
    author: 'Some author name',
    feedNamePath: 'jeff-tylerson-man',
    copyright: 'Abc Name 2023',
    category: 'Business',
    episodeDescription: 'This description gets added to all episode descriptions',
    showEpisodeDescriptionAbove: false,
    createdAt: 2023-07-10T23:44:59.550Z
}

Get My Podcasts

GET/api/v1/podcasts

Response

[
    {
        _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
        title: 'Title of this podcast',
        thumbnail: 'url to image',
        description: 'lorem ipsom sier die',
        author: 'Some author name',
        feedNamePath: 'jeff-tylerson-man',
        copyright: 'Abc Name 2023',
        category: 'Business',
        episodeDescription: 'This description gets added to all episode descriptions',
        showEpisodeDescriptionAbove: false,
        createdAt: 2023-07-10T23:44:59.550Z
    },
    ...
]

Get One Podcast

GET/api/v1/podcasts/:podcastId

Response

{
        _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
        title: 'Title of this podcast',
        thumbnail: 'url to image',
        description: 'lorem ipsom sier die',
        author: 'Some author name',
        feedNamePath: 'jeff-tylerson-man',
        copyright: 'Abc Name 2023',
        category: 'Business',
        episodeDescription: 'This description gets added to all episode descriptions',
        showEpisodeDescriptionAbove: false,
        createdAt: 2023-07-10T23:44:59.550Z
}

Create a Podcast

POST/api/v1/podcasts

Body

{
        title: 'Title of this podcast',
        thumbnail: 'url to image',
        description: 'lorem ipsom sier die',
        author: 'Some author name',
        feedNamePath: 'jeff-tylerson-man',
        copyright: 'Abc Name 2023',
        category: 'Business',
        episodeDescription: 'This description gets added to all episode descriptions',
        showEpisodeDescriptionAbove: false
}

Response

{
        _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
        title: 'Title of this podcast',
        thumbnail: 'url to image',
        description: 'lorem ipsom sier die',
        author: 'Some author name',
        feedNamePath: 'jeff-tylerson-man',
        copyright: 'Abc Name 2023',
        category: 'Business',
        episodeDescription: 'This description gets added to all episode descriptions',
        showEpisodeDescriptionAbove: false,
        createdAt: 2023-07-10T23:44:59.550Z
}

Update a Podcast

PUT/api/v1/podcasts/:podcastId

Body

{
    title: 'Title of this podcast',
    thumbnail: 'url to image',
    description: 'lorem ipsom sier die',
    author: 'Some author name',

    // feedName: 'jeff-tylerson-man'  FEED NAME CANNOT BE UPDATED ONCE CREATED

    copyright: 'Abc Name 2023',
    category: 'Business',
    episodeDescription: 'This description gets added to all episode descriptions',
    showEpisodeDescriptionAbove: false,
}

Response

{
        _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
        title: 'Title of this podcast',
        thumbnail: 'url to image',
        description: 'lorem ipsom sier die',
        author: 'Some author name',
        feedNamePath: 'jeff-tylerson-man',
        copyright: 'Abc Name 2023',
        category: 'Business',
        episodeDescription: 'This description gets added to all episode descriptions',
        showEpisodeDescriptionAbove: false,
        createdAt: 2023-07-10T23:44:59.550Z
}

Get Episodes of a podcast

GET/api/v1/podcasts/:podcastId/episodes

Response

[
    {
        _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
        title: 'title of the video, this is directly from youtube',
        thumbnail: 'url to image',
        transcribeStatus: 'waiting' | 'pending' | 'transcribing' | 'done' | 'too long'
        description: 'lorem ipsom sir edie diffad',
        srtText: '00:00:01 some text....',
        dateOfVideo: '2023-07-10T23:44:59.550Z'
    },
    ...
]

Add Episode to a podcast

POST/api/v1/podcasts/:podcastId/episodes

Body

{
    // add one youtube video
    videoUrl: 'https://www.youtube.com/watch?v=hCw8VSZunGg'

    // or 

    // add videos from youtube channel ( latest 50 videos )
    channelUrl: 'https://www.youtube.com/channel/UCG2v6cEMYMuhBcc0K5o1Ewg'

    // or

    // add videos from playlist
    playlistUrl: 'https://www.youtube.com/playlist?list=PLnTz1m14w1LwcSAQcSIQt35bfBZPArgKl'
}

Response ( Added by videoUrl )

// if added one video, will return single object
{
    _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
    title: 'title of the video, this is directly from youtube',
    thumbnail: 'url to image',
    transcribeStatus: 'waiting' | 'pending' | 'transcribing' | 'done' | 'too long'
    description: 'lorem ipsom sir edie diffad',
    srtText: '00:00:01 some text....',
    dateOfVideo: '2023-07-10T23:44:59.550Z'
}

Response ( Added by channelUrl or playlistUrl)

// if added videos from a channel or playlist, will return array
[
    {
        _id: '692fa3fa34fa34fefe4fafoiaejmvdkfv4',
        title: 'title of the video, this is directly from youtube',
        thumbnail: 'url to image',
        transcribeStatus: 'waiting' | 'pending' | 'transcribing' | 'done' | 'too long'
        description: 'lorem ipsom sir edie diffad',
        srtText: '00:00:01 some text....',
        dateOfVideo: '2023-07-10T23:44:59.550Z'
    },
    ...
]