Status Skill Card - Box Dev Docs

API version 2024.0 A Box Skill metadata card that puts a status message in the metadata sidebar.

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.

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: statusAn optional identifier for the title.

message

string

example: StatusThe actual title to show in the UI.

skill_card_type

string

example: statusThe value will always be status.Value is always status

status

object

Sets the status of the skill. This can be used to show a message to the user while the Skill is processing the data, or if it was not able to process the file.

Show child attributes

code

string

example: successA code for the status of this Skill invocation. By default each of these will have their own accompanied messages. These can be adjusted by setting the message value on this object.Value is one of invoked,processing,success,transient_failure,permanent_failure

message

string

example: We're preparing to process your file. Please hold on!A custom message that can be provided with this status. This will be shown in the web app to the end user.

{
  "type": "skill_card",
  "created_at": "2018-04-13T13:53:23-07:00",
  "invocation": {
    "id": "image-recognition-service-123",
    "type": "skill_invocation"
  },
  "skill": {
    "id": "image-recognition-service",
    "type": "service"
  },
  "skill_card_title": {
    "code": "status",
    "message": "Status"
  },
  "skill_card_type": "status",
  "status": {
    "code": "success",
    "message": "We're preparing to process your file. Please hold on!"
  }
}