Timeline Skill Card

A Box Skill metadata card that places a list of images on a timeline.

string
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 total duration in seconds of the timeline.

object array

A list of entries on the timeline.

object array

Defines a list of timestamps for when this item should appear on the timeline.

20

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

1

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

https://example.com/image1.jpg

The image to show on a for an entry that appears on a timeline. This image URL is required for every entry.

The image will be shown in a list of items (for example faces), and clicking the image will show the user where that entry appears during the duration of this entry.

John

The text of the entry. This would be the display name for an item being placed on the timeline, for example the name of the person who was detected in a video.

object

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

image-recognition-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.

skill_invocation

Value is always skill_invocation

object

The service that applied this metadata.

string
image-recognition-service

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

string
service

Value is always service

The title of the card.

Faces

An optional identifier for the title.

Faces

The actual title to show in the UI.

timeline

Value is always timeline

Response Example

{
  "type": "skill_card",
  "created_at": "2018-04-13T13:53:23-07:00",
  "duration": 1000,
  "entries": [
    {
      "text": "John",
      "appears": [
        {
          "start": 1,
          "end": 20
        }
      ],
      "image_url": "https://example.com/image1.jpg"
    }
  ],
  "invocation": {
    "id": "image-recognition-service-123",
    "type": "skill_invocation"
  },
  "skill": {
    "id": "image-recognition-service",
    "type": "service"
  },
  "skill_card_title": {
    "code": "Faces",
    "message": "Faces"
  },
  "skill_card_type": "timeline"
}