Transcript Skill Card

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TranscriptSkillCard",
  "title": "Transcript Skill Card",
  "type": "object",
  "x-box-resource-id": "transcript_skill_card",
  "x-box-tag": "skills",
  "description": "A Box Skill metadata card that adds a transcript to a file.",
  "required": [
    "type",
    "skill_card_type",
    "skill",
    "invocation",
    "entries"
  ],
  "properties": {
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2018-04-13T13:53:23-07:00",
      "description": "The optional date and time this card was created at."
    },
    "type": {
      "type": "string",
      "description": "`skill_card`",
      "example": "skill_card",
      "enum": [
        "skill_card"
      ]
    },
    "skill_card_type": {
      "type": "string",
      "description": "`transcript`",
      "example": "transcript",
      "enum": [
        "transcript"
      ]
    },
    "skill_card_title": {
      "type": "object",
      "description": "The title of the card.",
      "required": [
        "message"
      ],
      "properties": {
        "code": {
          "type": "string",
          "example": "my_transcripts",
          "description": "An optional identifier for the title."
        },
        "message": {
          "type": "string",
          "example": "My Transcripts",
          "description": "The actual title to show in the UI."
        }
      }
    },
    "skill": {
      "type": "object",
      "description": "The service that applied this metadata.",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "example": "service",
          "description": "`service`",
          "enum": [
            "service"
          ]
        },
        "id": {
          "type": "string",
          "example": "transciption-service",
          "description": "A custom identifier that represent the service that\napplied this metadata."
        }
      }
    },
    "invocation": {
      "type": "object",
      "description": "The invocation of this service, used to track\nwhich instance of a service applied the metadata.",
      "required": [
        "type",
        "id"
      ],
      "properties": {
        "type": {
          "type": "string",
          "example": "skill_invocation",
          "description": "`skill_invocation`",
          "enum": [
            "skill_invocation"
          ]
        },
        "id": {
          "type": "string",
          "example": "transciption-service-123",
          "description": "A custom identifier that represent the instance of\nthe service that applied this metadata. For example,\nif your `image-recognition-service` runs on multiple\nnodes, this field can be used to identify the ID of\nthe node that was used to apply the metadata."
        }
      }
    },
    "duration": {
      "type": "integer",
      "example": 1000,
      "description": "An optional total duration in seconds.\n\nUsed with a `skill_card_type` of `transcript` or\n`timeline`."
    },
    "entries": {
      "type": "array",
      "description": "An list of entries for the card. This represents the individual entries of\nthe transcription.",
      "items": {
        "type": "object",
        "description": "An entry in the `entries` attribute of a metadata card",
        "properties": {
          "text": {
            "type": "string",
            "example": "Hi, and welcome to this video...",
            "description": "The text of the entry. This would be the transcribed text assigned\nto the entry on the timeline."
          },
          "appears": {
            "type": "array",
            "description": "Defines when a transcribed bit of text appears. This only includes a\nstart time and no end time.",
            "required": [
              "start"
            ],
            "items": {
              "type": "object",
              "description": "The timestamp for an entry.",
              "properties": {
                "start": {
                  "type": "integer",
                  "example": 1,
                  "description": "The time in seconds when an\nentry should start appearing on a timeline."
                }
              }
            }
          }
        }
      }
    }
  }
}