Box Developer Documentation
Log in
Latest version

Create Box Skill cards on file

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

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Applies one or more Box Skills metadata cards to a file.

Related Guides

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.

Request Body

[ Keyword Skill Card / Status Skill Card / Timeline Skill Card / Transcript Skill Card ] arrayin bodyrequired

A list of Box Skill cards to apply to this file.

Response

application/jsonSkills metadata instance

Returns the instance of the template that was applied to the file, including the data that was applied to the template.

application/jsonClient error

Returns an error when the request body is not valid.

  • schema_validation_failed - The request body contains a value for a field that either does not exist, or for which the value or type does not match the expected field type. An example might be an unknown option for an enum or multiSelect field.
application/jsonClient error

Returns an error when the file or metadata template was not found.

  • not_found - The file could not be found, or the user does not have access to the file.
  • instance_tuple_not_found - The metadata template was not found.
application/jsonClient error

Returns an error when an instance of this metadata template is already present on the file.

  • tuple_already_exists - An instance of them metadata template already exists on the file.
application/jsonClient error

An unexpected client error.

post
Create 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 POST "https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -H "content-type: application/json" \
     -d '{
       "cards": [{
         "type": "skill_card",
         "skill_card_type": "keyword",
         "skill_card_title": {
           "code": "license-plates",
           "message": "Licence Plates"
         },
         "skill": {
           "type": "service"
           "id": "license-plates-service"
         },
         "invocation": {
           "type": "skill_invocation"
           "id": "license-plates-service-123"
         },
         "entries": {
           { "text": "DD-26-YT" },
           { "text": "DN86 BOX" }
         }
       },{
         "type": "skill_card",
         "skill_card_type": "transcript",
         "skill_card_title": {
           "code": "video-transcription",
           "message": "Video Transcription"
         },
         "skill": {
           "type": "service"
           "id": "video-transcription-service"
         },
         "invocation": {
           "type": "skill_invocation"
           "id": "video-transcription-service-123"
         },
         "duration": 1000,
         "entries": {
           {
             "text": "Hi John, have I told you about Box recently?",
             "appears": [{ "start": 0 }]
           },
           {
             "text": "No Aaron, you have not. Tell me more!",
             "appears": [{ "start": 5 }]
           }
         }
       },{
         "type": "skill_card",
         "skill_card_type": "timeline",
         "skill_card_title": {
           "code": "face-detection",
           "message": "Faces"
         },
         "skill": {
           "type": "service"
           "id": "face-detection-service"
         },
         "invocation": {
           "type": "skill_invocation"
           "id": "face-detection-service-123"
         },
         "duration": 1000,
         "entries": {
           {
             "text": "John",
             "appears": [{ "start": 0, "end": 5 }, { "start": 10, "end": 15 }],
             "image_url": "https://example.com/john.png"
           },
           {
             "text": "Aaron",
             "appears": [{ "start": 5, "end": 10 }],
             "image_url": "https://example.com/aaron.png"
           }
         }
       },{
         "type": "skill_card",
         "skill_card_type": "status",
         "skill_card_title": {
           "code": "hold",
           "message": "Please hold..."
         },
         "skill": {
           "type": "service"
           "id": "face-detection-service"
         },
         "invocation": {
           "type": "skill_invocation"
           "id": "face-detection-service-123"
         },
         "status": {
           "code": "processing",
           "message": "We are processing this file right now."
         }
       }],
     }'
TypeScript Gen
await client.skills.createBoxSkillCardsOnFile(file.id, {
  cards: [
    {
      type: 'skill_card',
      skillCardType: 'keyword',
      skillCardTitle: { code: 'license-plates', message: titleMessage },
      skill: { id: skillId, type: 'service' },
      invocation: { id: invocationId, type: 'skill_invocation' },
      entries: [{ text: 'DN86 BOX' }],
    } satisfies KeywordSkillCardOrStatusSkillCardOrTimelineSkillCardOrTranscriptSkillCard,
  ],
} satisfies CreateBoxSkillCardsOnFileRequestBody);
Python Gen
client.skills.create_box_skill_cards_on_file(
    file.id,
    [
        KeywordSkillCard(
            type=KeywordSkillCardTypeField.SKILL_CARD,
            skill_card_type=KeywordSkillCardSkillCardTypeField.KEYWORD,
            skill_card_title=KeywordSkillCardSkillCardTitleField(
                code="license-plates", message=title_message
            ),
            skill=KeywordSkillCardSkillField(
                id=skill_id, type=KeywordSkillCardSkillTypeField.SERVICE
            ),
            invocation=KeywordSkillCardInvocationField(
                id=invocation_id,
                type=KeywordSkillCardInvocationTypeField.SKILL_INVOCATION,
            ),
            entries=[KeywordSkillCardEntriesField(text="DN86 BOX")],
        )
    ],
)

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"
    }
  ]
}