3Play Media: Docs

Cheat Sheets

Create, update and view cheat sheets for your videos at 3Play Media

Object Representation

Unless otherwise specified, all routes return the following data structure in the data key.

Name Type Description
id Integer Your cheat sheet ID
resource_id Integer The resource ID that the cheat sheet belongs to. For example, a Project, Batch, or MediaFile ID.
resource_type String The resource type that the cheat sheet belongs to. Possible values are: Project, Batch, and MediaFile
content String The text content of the cheat sheet
content_type String The content type of the cheat sheet. Possible values are: lyrics, event_program, script, and speaker_list

Actions

  • List cheat sheets in your project

    GET https://api.3playmedia.com/v3/cheat_sheets

    Parameter Type Description Required Default
    resource_type String Filter by resource types. Possible values: 'Project', 'Batch', 'MediaFile'. Yes Project
    content_type String Filter by content types. Possible valies: 'lyrics', 'event_program', 'script', 'speaker_list'. No no default
    service_type String Filter by service types. Possible values: 'TranscriptionService', 'AudioDescriptionService'. No TranscriptionService
  • Show your Cheat Sheet

    GET https://api.3playmedia.com/v3/cheat_sheets/:id

  • Create a Cheat Sheet

    POST https://api.3playmedia.com/v3/cheat_sheets

    Parameter Type Description Required Default
    resource_id Integer The resource ID that the cheat sheet belongs to. For example, a Project, Batch, or MediaFile ID.
    resource_type String Select which resource type to connect your cheat sheet to. Possible values: 'Project', 'Batch', 'MediaFile'. Yes Project
    content_type String Select which content type describes your content. Possible values: 'lyrics', 'event_program', 'script', 'speaker_list'. Yes no default
    service_type String Select which service type to create the cheat sheet for. Possible values: 'TranscriptionService', 'AudioDescriptionService'. Yes TranscriptionService
    content String The text content of the cheat sheet No no default
    pdf_attachment File The pdf content of the cheat sheet No no default
  • Update an existing cheat sheet

    PUT https://api.3playmedia.com/v3/cheat_sheets/:id

    Parameter Type Description Required Default
    content_type String Select which content type describes your content. Possible values: 'lyrics', 'event_program', 'script', 'speaker_list'. No no default
    service_type String Select which service type to apply your the cheat sheet to. Possible values: 'TranscriptionService', 'AudioDescriptionService'. No no default
    content String The text content of the cheat sheet No no default
    pdf_attachment File The pdf content of the cheat sheet No no default