v1

latestOpenAPI 3.0.2Apache-2.02026-07-142963051.0 MB

Skills

Update all Box Skill cards on file

An alternative method that can be used to overwrite and update all Box Skill metadata cards on a file.

put/skill_invocations/{skill_id}

Path parameters

skill_idstring required

The ID of the skill to apply this metadata for.

Request body

status'invoked' | 'processing' | 'success' | 'transient_failure' | 'permanent_failure' required

Defines the status of this invocation. Set this to success when setting Skill cards.

Example request

{
  "status": "success",
  "metadata": {
    "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"
          }
        ]
      }
    ]
  },
  "file": {
    "type": "file",
    "id": "3243244"
  },
  "file_version": {
    "type": "file_version",
    "id": "731381601045"
  },
  "usage": {
    "unit": "file",
    "value": 1
  }
}

Response

Returns an empty response when the card has been successfully updated.