Metadata Card

A Box Skills card that is applied to the metadata of a file.

string / date-time
2012-12-12T10:53:43-08:00

The time the card was created at

integer
1000

An optional duration.

Used with a card_type oftranscript, or timeline.

An optional list of entries.

Used with a card_type oftranscript, keyword or timeline.

object

The current invocation of the skill

string
33243242

The ID of the skill invocation.

string
skill_invocation

Value is always "skill_invocation"

object

The skill that is updating the cards

string
43342423234

The ID of the skill.

string
service

Value is always "service"

The title of the card

string
my_transcripts

An identifier for your title

string
My Transcripts

The actual title to show in the UI

status

The type of card to create

Value is one of "transcript", "keyword", "timeline", "status", "error"

object

Optional status. Used with a card_type of status.

string
skills_pending_status

The type of status being set

Value is one of "skills_pending_status", "custom_error"

string
We're preparing to process your file. Please hold on!

The message for the status to show in the UI

string
skill_card

Value is always "skills_card"

Response Example

{
  "type": "skill_card",
  "created_at": "2012-12-12T10:53:43-08:00",
  "skill_card_type": "status",
  "skill": {
    "type": "service",
    "id": 43342423234
  },
  "skill_card_title": {
    "code": "my_transcripts",
    "message": "My Transcripts"
  },
  "invocation": {
    "type": "skill_invocation",
    "id": 33243242
  },
  "status": {
    "code": "skills_pending_status",
    "message": "We're preparing to process your file. Please hold on!"
  },
  "entries": [
    {
      "type": "text",
      "text": "keyword1"
    }
  ],
  "duration": 1000
}