Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Skills metadata instance

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

The metadata assigned to a using for Box skills.

boolean
true

Whether the user can edit this metadata.

string (uuid)
01234500-12f1-1234-aa12-b1d234cb567e
36

A UUID to identify the metadata object.

string
folder_59449484661,

An ID for the parent folder.

string
enterprise_27335

An ID for the scope in which this template has been applied.

string
properties

The name of the template.

string
properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0

A unique identifier for the "type" of this instance. This is an internal system property and should not be used by a client application.

integer
2

The last-known version of the template of the object. This is an internal system property and should not be used by a client application.

integer
1

The version of the metadata object. Starts at 0 and increases every time a user-defined property is modified.

object [ Keyword Skill Card / Status Skill Card / Timeline Skill Card / Transcript Skill Card. ] array

A list of Box Skill cards that have been applied to this file.

Response Example

{
  "$canEdit": true,
  "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "properties",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2,
  "$version": 1,
  "cards": [
    {
      "created_at": "2018-04-13T13:53:23-07:00",
      "entries": [
        {
          "text": "keyword1"
        }
      ],
      "invocation": {
        "id": "image-recognition-service-123",
        "type": "skill_invocation"
      },
      "skill": {
        "id": "image-recognition-service",
        "type": "service"
      },
      "skill_card_title": {
        "code": "labels",
        "message": "Labels"
      },
      "skill_card_type": "keyword",
      "type": "skill_card"
    }
  ]
}