Box Developer Documentation
Log in
Latest version

List Box Skill cards on file

get
https://api.box.com/2.0
/files/:file_id/metadata/global/boxSkillsCards

List the Box Skills metadata cards that are attached to a file.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

The unique identifier that represents a file.

The ID for any file can be determined by visiting a file in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.

Response

application/jsonSkills metadata instance

Returns all the metadata associated with a file.

This API does not support pagination and will therefore always return all of the metadata associated to the file.

application/jsonClient error

An unexpected client error.

get
List Box Skill cards on file
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X PUT "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.skills.getBoxSkillCardsOnFile(file.id);
Python Gen
client.skills.get_box_skill_cards_on_file(file.id)

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",
      "type": "skill_card",
      "skill_card_type": "keyword",
      "skill_card_title": {
        "code": "labels",
        "message": "Labels"
      },
      "skill": {
        "type": "service",
        "id": "image-recognition-service"
      },
      "invocation": {
        "type": "skill_invocation",
        "id": "image-recognition-service-123"
      },
      "entries": [
        {
          "text": "keyword1"
        }
      ]
    }
  ]
}