Timeline Skill Card - Box Dev Docs

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

type

string

example: skill_cardThe value will always be skill_card.Value is always skill_card

created_at

string(date-time)

example: 2018-04-13T13:53:23-07:00The optional date and time this card was created at.

duration

integer

example: 1000An total duration in seconds of the timeline.

entries

object[]

A list of entries on the timeline.

Show child attributes

appears

object[]

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

Show child attributes

end

integer

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

start

integer

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

image_url

string

example: https://example.com/image1.jpgThe 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.

text

string

example: JohnThe 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.

invocation

object

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

Show child attributes

string

example: image-recognition-service-123A 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.

type

string

example: skill_invocationThe value will always be skill_invocation.Value is always skill_invocation

skill

object

The service that applied this metadata.

Show child attributes

string

example: image-recognition-serviceA custom identifier that represent the service that applied this metadata.

type

string

example: serviceThe value will always be service.Value is always service

skill_card_title

object

The title of the card.

Show child attributes

code

string

example: FacesAn optional identifier for the title.

message

string

example: FacesThe actual title to show in the UI.

skill_card_type

string

example: timelineThe value will always be timeline.Value is always timeline

{
  "type": "skill_card",
  "created_at": "2018-04-13T13:53:23-07:00",
  "duration": 1000,
  "entries": [
    {
      "appears": [
        {
          "end": 20,
          "start": 1
        }
      ],
      "image_url": "https://example.com/image1.jpg",
      "text": "John"
    }
  ],
  "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"
}