Box Developer Documentation
Log in

Transcript Skill Card

This resource is used by enpoints in the version 2024.0. For more details, see Box API versioning.

A Box Skill metadata card that adds a transcript to a file.

string
skill_card

skill_card

Value is always skill_card

string (date-time)
2018-04-13T13:53:23-07:00

The optional date and time this card was created at.

integer
1000

An optional total duration in seconds.

Used with a skill_card_type of transcript or timeline.

object array

An list of entries for the card. This represents the individual entries of the transcription.

object array

Defines when a transcribed bit of text appears. This only includes a start time and no end time.

integer
1

The time in seconds when an entry should start appearing on a timeline.

string
Hi, and welcome to this video...

The text of the entry. This would be the transcribed text assigned to the entry on the timeline.

object

The invocation of this service, used to track which instance of a service applied the metadata.

string
transciption-service-123

A custom identifier that represent the instance of the service that applied this metadata. For example, if your image-recognition-service runs on multiple nodes, this field can be used to identify the ID of the node that was used to apply the metadata.

string
skill_invocation

skill_invocation

Value is always skill_invocation

object

The service that applied this metadata.

string
transciption-service

A custom identifier that represent the service that applied this metadata.

string
service

service

Value is always service

object

The title of the card.

string
my_transcripts

An optional identifier for the title.

string
My Transcripts

The actual title to show in the UI.

string
transcript

transcript

Value is always transcript

Response Example

{
  "type": "skill_card",
  "created_at": "2018-04-13T13:53:23-07:00",
  "duration": 1000,
  "entries": [
    {
      "appears": [
        {
          "start": 1
        }
      ],
      "text": "Hi, and welcome to this video..."
    }
  ],
  "invocation": {
    "id": "transciption-service-123",
    "type": "skill_invocation"
  },
  "skill": {
    "id": "transciption-service",
    "type": "service"
  },
  "skill_card_title": {
    "code": "my_transcripts",
    "message": "My Transcripts"
  },
  "skill_card_type": "transcript"
}