> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Update Box Skill cards on file
> Updates one or more Box Skills metadata cards to a file.
This endpoint is in the version **2024.0**. No changes are required to continue using it. For more details, see **[Box API versioning](/guides/api-calls/api-versioning-strategy)**.
Learn more about [Box SDK versioning strategy](/guides/tooling/sdks/sdk-versioning/).
## OpenAPI
````yaml /box-openapi.json PUT /files/{file_id}/metadata/global/boxSkillsCards
openapi: 3.0.2
info:
title: Box Platform API
description: >-
[Box Platform](https://developer.box.com) provides functionality to provide
access to content stored within [Box](https://box.com). It provides
endpoints for basic manipulation of files and folders, management of users
within an enterprise, as well as more complex topics such as legal holds and
retention policies.
termsOfService: https://cloud.app.box.com/s/rmwxu64h1ipr41u49w3bbuvbsa29wku9
contact:
name: Box, Inc
url: https://developer.box.com
email: devrel@box.com
license:
name: Apache-2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: '2024.0'
x-box-commit-hash: 95117b97f9
servers:
- url: https://api.box.com/2.0
description: Box Platform API server.
security:
- OAuth2Security: []
tags:
- name: AI
description: A set of endpoints used to interact with supported LLMs.
x-box-tag: ai
- name: AI Studio
description: A set of endpoints used to interact with AI Studio.
x-box-tag: ai_studio
- name: App item associations
x-box-tag: app_item_associations
- name: Authorization
description: A set of endpoints used to manage user authorization process.
x-box-tag: authorization
x-box-priority: true
- name: Box Sign requests
description: Box Sign requests are used to submit a file for signature.
x-box-tag: sign_requests
- name: Classifications
description: >-
Classification labels are used for content that is sensitive or under
security restrictions.
x-box-tag: classifications
- name: Classifications on files
description: >-
Classification labels are used for files that are sensitive or under
security restrictions.
x-box-tag: file_classifications
- name: Classifications on folders
description: >-
Classification labels are used for folders that are sensitive or under
security restrictions.
x-box-tag: folder_classifications
- name: Collaborations
description: >-
Collaborations define access permissions for users and groups to files and
folders, similar to access control lists.
x-box-tag: user_collaborations
- name: Collaborations (List)
description: >-
A set of endpoints used to retrieve file, folder, pending, and group
collaborations.
x-box-tag: list_collaborations
- name: Collections
description: >-
Collections are a way to group files, folders, and web links without
putting them all into a folder.
x-box-tag: collections
- name: Comments
description: >-
Comments are messages generated users on files, allowing users to
collaborate on a file, discussing any feedback they might have on the
content.
x-box-tag: comments
- name: Device pinners
description: >-
Device pinners allow enterprises to control what devices can use native
Box applications.
x-box-tag: device_pinners
- name: Domain restrictions (User exemptions)
description: >-
A set of endpoints that allow exempting users from restrictions imposed by
the list of allowed collaboration domains for a specific enterprise.
x-box-tag: collaboration_allowlist_exempt_targets
- name: Domain restrictions for collaborations
description: >-
A set of endpoints that manage domains for which users can collaborate
with files and folders in an enterprise.
x-box-tag: collaboration_allowlist_entries
- name: Downloads
description: >-
Downloads allow saving files to the application's server, or directly by
the end user in a browser.
x-box-tag: downloads
- name: Email aliases
description: >-
Email aliases provide a list of emails additional to the user's primary
login email.
x-box-tag: email_aliases
- name: Events
description: >-
Events provide a way for an application to subscribe to any actions
performed by any user, users, or service in an enterprise.
x-box-tag: events
- name: File requests
description: >-
File Requests provide a fast and secure way to request files and
associated metadata from anyone. Users can create new file requests based
on an existing file request, update file request settings, activate,
deactivate, and delete file requests programmatically.
x-box-tag: file_requests
- name: File version legal holds
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated. A File Version Legal Hold represents all the
policies that are assigned to a specific file version.
x-box-tag: file_version_legal_holds
- name: File version retentions
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. A file version retention is a record for a retained file.
x-box-tag: file_version_retentions
- name: File versions
description: A set of endpoints used to manage specific versions of a file.
x-box-tag: file_versions
- name: Files
description: >-
Files, together with Folders, are at the core of the Box API. Files can be
uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: files
- name: Folder Locks
description: >-
Folder locks define access restrictions placed by folder owners to prevent
specific folders from being moved or deleted.
x-box-tag: folder_locks
- name: Folders
description: >-
Folders, together with Files, are at the core of the Box API. Folders can
be uploaded and downloaded, as well as hold important metadata information
about the content.
x-box-tag: folders
- name: Integration mappings
description: >-
Integration Mappings allow the users to manage where content from partner
apps is stored in Box.
x-box-tag: integration_mappings
- name: Group memberships
description: Group memberships signify that a user is a part of the group.
x-box-tag: memberships
- name: Groups
description: Groups created in an enterprise.
x-box-tag: groups
- name: Invites
description: Invites are used to invite the user to an enterprise.
x-box-tag: invites
- name: Legal hold policies
description: >-
A legal hold is a process that an enterprise can use to preserve all forms
of potentially relevant information when litigation is pending or
reasonably anticipated.
x-box-tag: legal_hold_policies
- name: Legal hold policy assignments
description: >-
A Legal Hold Policy Assignment is a relation between a policy and
custodian. In this case, as custodian can be a user, folder, file, or file
version.
x-box-tag: legal_hold_policy_assignments
- name: Metadata cascade policies
description: >-
A metadata cascade policy describes how metadata instances applied to a
folder should be applied to any item within that folder.
x-box-tag: metadata_cascade_policies
- name: Metadata instances (Files)
description: >-
A metadata instance describes the relation between a template and a file,
including the values that are assigned for every field.
x-box-tag: file_metadata
- name: Metadata instances (Folders)
description: >-
A metadata instance describes the relation between a template and a
folder, including the values that are assigned for every field.
x-box-tag: folder_metadata
- name: Metadata taxonomies
description: >-
A metadata taxonomy is a hierarchical classification system that helps
organize and manage metadata within an enterprise.
x-box-tag: metadata_taxonomies
- name: Metadata templates
description: >-
A metadata template describes a reusable set of key/value pairs that can
be assigned to a file.
x-box-tag: metadata_templates
- name: Recent items
description: >-
Recent items represent items such as files or folders that the user
accessed recently.
x-box-tag: recent_items
- name: Retention policies
description: >-
A retention policy blocks permanent deletion of content for a specified
amount of time. Admins can create retention policies and then assign them
to specific folders or their entire enterprise.
x-box-tag: retention_policies
- name: Retention policy assignments
description: >-
A Retention Policy Assignment is a relation between a policy and folder or
enterprise. Creating an assignment puts a retention on all the file
versions that belong to that folder or enterprise.
x-box-tag: retention_policy_assignments
- name: Search
description: >-
The Box API provides a way to find content in Box using full-text search
queries.
x-box-tag: search
- name: Session termination
description: >-
Session termination API is used to validate the roles and permissions of
the group, and creates asynchronous jobs to terminate the group's
sessions.
x-box-tag: session_termination
- name: Shared links (Files)
description: >-
Files shared links are URLs that are generated for files stored in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_files
- name: Shared links (Folders)
description: >-
Folders shared links are URLs that are generated for folders stored in
Box, which provide direct, read-only access to the resource.
x-box-tag: shared_links_folders
- name: Shared links (Web Links)
description: >-
Web links for files are URLs that are generated for web links in Box,
which provide direct, read-only access to the resource.
x-box-tag: shared_links_web_links
- name: Shared links (App Items)
description: >-
URLs generated for app items stored in Box, which provide direct,
read-only access to the resource.
x-box-tag: shared_links_app_items
- name: Shield information barriers
description: >-
Shield information barrier in Box defines an ethical wall. An ethical wall
is a mechanism that prevents exchanges or communication that could lead to
conflicts of interest and therefore result in business activities
ethically or legally questionable.
x-box-tag: shield_information_barriers
- name: Shield information barrier segments
description: >-
Shield information barrier segment represents a defined group of users. A
user can be a member of only one segment, which makes segments different
from groups.
x-box-tag: shield_information_barrier_segments
- name: Shield information barrier segment members
description: >-
Shield information barrier segment member represents a user that is
assigned to a specific segment.
x-box-tag: shield_information_barrier_segment_members
- name: Shield information barrier reports
description: >-
Shield information barrier reports contain information on what existing
collaborations will be removed permanently when the information barrier is
enabled.
x-box-tag: shield_information_barrier_reports
- name: Shield information barrier segment restrictions
description: >-
Shield information barrier segment restriction is an access restriction
based on the content (file or folder) owner.
x-box-tag: shield_information_barrier_segment_restrictions
- name: Box Sign templates
description: >-
Sign templates allow you to use a predefined Box Sign template when
creating a signature request. The template includes placeholders that are
automatically populated with data when creating the request.
x-box-tag: sign_templates
- name: Skills
description: >-
Box Skills are designed to allow custom processing of files uploaded to
Box, with the intent of enhancing the underlying metadata of the file.
x-box-tag: skills
- name: Standard and Zones Storage Policies
description: >-
Storage policy assignment represents the storage zone for items in a given
enterprise.
x-box-tag: storage_policies
- name: Standard and Zones Storage Policy Assignments
description: >-
Storage policy assignment represents the relation between storage zone and
the assigned item (for example a file stored in a specific zone).
x-box-tag: storage_policy_assignments
- name: Task assignments
description: >-
A task assignment defines which task is assigned to which user to
complete.
x-box-tag: task_assignments
- name: Tasks
description: >-
Tasks allow users to request collaborators on a file to review a file or
complete a piece of work. Tasks can be used by developers to create
file-centric workflows.
x-box-tag: tasks
- name: Terms of service
description: A set of endpoints used to manage terms of service agreements.
x-box-tag: terms_of_services
- name: Terms of service user statuses
description: >-
A set of endpoints used to manage the status of terms of service for a
particular user.
x-box-tag: terms_of_service_user_statuses
- name: Transfer folders
description: >-
API designed to move all of the items (files, folders and workflows) owned
by a user into another user's account.
x-box-tag: transfer
- name: Trashed files
description: Files that were deleted and are in trash.
x-box-tag: trashed_files
- name: Trashed folders
description: Folders that were deleted and are in trash.
x-box-tag: trashed_folders
- name: Trashed items
description: Items that were deleted and are in trash.
x-box-tag: trashed_items
- name: Trashed web links
description: Web links that were deleted and are in trash.
x-box-tag: trashed_web_links
- name: Uploads
description: >-
The direct file upload API supports files up to 50MB in size and sends all
the binary data to the Box API in 1 API request.
x-box-tag: uploads
- name: Uploads (Chunked)
description: >-
The chunked upload endpoints support files from 20MB in size and allow an
application to upload the file in parts, allowing for more control to
catch any errors and retry parts individually.
x-box-tag: chunked_uploads
- name: User avatars
description: >-
User avatars are JPG or PNG files uploaded to Box to represent the user
image. They are then displayed in the user account.
x-box-tag: avatars
- name: Users
description: >-
Box API supports a variety of users, ranging from real employees logging
in with their Managed User account, to applications using App Users to
drive powerful automation workflows.
x-box-tag: users
- name: Watermarks (Files)
description: >-
A watermark is a semi-transparent overlay on an embedded file preview that
displays a viewer's email address or user ID and the time of access over
the file.
x-box-tag: file_watermarks
- name: Watermarks (Folders)
description: >-
A watermark is a semi-transparent overlay on an embedded folder preview
that displays a viewer's email address or user ID and the time of access
over the folder content.
x-box-tag: folder_watermarks
- name: Web links
description: >-
Web links are objects that point to URLs. These objects are also known as
bookmarks within the Box web application.
x-box-tag: web_links
- name: Webhooks
description: >-
Webhooks allow you to monitor Box content for events, and receive
notifications to a URL of your choice when they occur. For example, a
workflow may include waiting for a file to be downloaded to delete a
shared link.
x-box-tag: webhooks
- name: Workflows
description: >-
Box Relay Workflows are objects that represent a named collection of
flows.
x-box-tag: workflows
- name: Zip Downloads
description: >-
Zip downloads represent a successful request to create a ZIP archive with
files and folders.
x-box-tag: zip_downloads
externalDocs:
description: Box Developer Documentation.
url: https://developer.box.com
paths:
/files/{file_id}/metadata/global/boxSkillsCards:
put:
tags:
- Skills
summary: Update Box Skill cards on file
description: Updates one or more Box Skills metadata cards to a file.
operationId: put_files_id_metadata_global_boxSkillsCards
parameters:
- name: file_id
in: path
description: >-
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`.
required: true
schema:
type: string
example: '12345'
requestBody:
content:
application/json-patch+json:
schema:
description: >-
A [JSON-Patch](https://tools.ietf.org/html/rfc6902)
specification for the changes to make to the metadata template.
The changes are represented as a JSON array of operation
objects.
type: array
items:
type: object
description: An operation that replaces an existing card.
properties:
op:
description: The value will always be `replace`.
type: string
example: replace
enum:
- replace
path:
description: >-
The JSON Path that represents the card to replace. In most
cases this will be in the format `/cards/{index}` where
`index` is the zero-indexed position of the card in the
list of cards.
type: string
example: /cards/0
value:
allOf:
- $ref: '#/components/schemas/SkillCard'
- description: >-
The card to insert into the list of cards at the
position defined by `path`.
responses:
'200':
description: >-
Returns the updated metadata template, with the custom template data
included.
content:
application/json:
schema:
$ref: '#/components/schemas/SkillCardsMetadata'
'404':
description: The requested file could not be found.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
default:
description: An unexpected client error.
content:
application/json:
schema:
$ref: '#/components/schemas/ClientError'
x-codeSamples:
- lang: curl
label: Update Box Skill cards on file
source: >-
curl -i -X PUT
"https://api.box.com/2.0/files/12345/metadata/global/boxSkillsCards"
\
-H "authorization: Bearer " \
-H "content-type: application/json-patch+json" \
-d '[
"op": "replace",
"path": "/cards/0",
"value": {
"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" }
}
}
]'
- lang: java
label: Update Box Skill cards on file
source: >-
client.getSkills().updateBoxSkillCardsOnFile(file.getId(),
Arrays.asList(new
UpdateBoxSkillCardsOnFileRequestBody.Builder().op(UpdateBoxSkillCardsOnFileRequestBodyOpField.REPLACE).path("/cards/0").value(cardToUpdate).build()))
- lang: node
label: Update Box Skill cards on file
source: |-
await client.skills.updateBoxSkillCardsOnFile(file.id, [
{
op: 'replace' as UpdateBoxSkillCardsOnFileRequestBodyOpField,
path: '/cards/0',
value: cardToUpdate,
} satisfies UpdateBoxSkillCardsOnFileRequestBody,
]);
- lang: python
label: Update Box Skill cards on file
source: |-
client.skills.update_box_skill_cards_on_file(
file.id,
[
UpdateBoxSkillCardsOnFileRequestBody(
op=UpdateBoxSkillCardsOnFileRequestBodyOpField.REPLACE,
path="/cards/0",
value=card_to_update,
)
],
)
components:
schemas:
SkillCard:
description: Box Skill card.
type: object
oneOf:
- $ref: '#/components/schemas/KeywordSkillCard'
- $ref: '#/components/schemas/TimelineSkillCard'
- $ref: '#/components/schemas/TranscriptSkillCard'
- $ref: '#/components/schemas/StatusSkillCard'
title: Box Skill card
SkillCardsMetadata:
description: The metadata assigned to a using for Box skills.
type: object
properties:
$canEdit:
description: Whether the user can edit this metadata.
type: boolean
example: true
$id:
description: A UUID to identify the metadata object.
type: string
format: uuid
example: 01234500-12f1-1234-aa12-b1d234cb567e
maxLength: 36
$parent:
description: An ID for the parent folder.
type: string
example: folder_59449484661,
$scope:
description: An ID for the scope in which this template has been applied.
type: string
example: enterprise_27335
$template:
description: The name of the template.
type: string
example: properties
$type:
description: >-
A unique identifier for the "type" of this instance. This is an
internal system property and should not be used by a client
application.
type: string
example: properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0
$typeVersion:
description: >-
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.
type: integer
example: 2
$version:
description: >-
The version of the metadata object. Starts at 0 and increases every
time a user-defined property is modified.
type: integer
example: 1
cards:
description: A list of Box Skill cards that have been applied to this file.
type: array
items:
$ref: '#/components/schemas/SkillCard'
title: Skills metadata instance
x-box-resource-id: skill_cards_metadata
x-box-tag: skills
ClientError:
description: A generic error.
type: object
properties:
type:
description: The value will always be `error`.
type: string
example: error
enum:
- error
nullable: false
status:
description: The HTTP status of the response.
type: integer
format: int32
example: 400
nullable: false
code:
description: A Box-specific error code.
type: string
example: item_name_invalid
enum:
- created
- accepted
- no_content
- redirect
- not_modified
- bad_request
- unauthorized
- forbidden
- not_found
- method_not_allowed
- conflict
- precondition_failed
- too_many_requests
- internal_server_error
- unavailable
- item_name_invalid
- insufficient_scope
message:
description: A short message describing the error.
type: string
example: Method Not Allowed
nullable: false
context_info:
description: >-
A free-form object that contains additional context about the error.
The possible fields are defined on a per-endpoint basis. `message`
is only one example.
type: object
example:
message: Something went wrong
additionalProperties: {}
nullable: true
help_url:
description: A URL that links to more information about why this error occurred.
type: string
example: >-
https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/
nullable: false
request_id:
description: >-
A unique identifier for this response, which can be used when
contacting Box support.
type: string
example: abcdef123456
nullable: false
title: Client error
x-box-resource-id: client_error
KeywordSkillCard:
description: A skill card that contains a set of keywords.
type: object
properties:
created_at:
description: The optional date and time this card was created at.
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: The value will always be `skill_card`.
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: The value will always be `keyword`.
type: string
example: keyword
enum:
- keyword
skill_card_title:
description: The title of the card.
type: object
properties:
code:
description: An optional identifier for the title.
type: string
example: labels
message:
description: The actual title to show in the UI.
type: string
example: Labels
required:
- message
skill:
description: The service that applied this metadata.
type: object
properties:
type:
description: The value will always be `service`.
type: string
example: service
enum:
- service
id:
description: >-
A custom identifier that represent the service that applied this
metadata.
type: string
example: image-recognition-service
required:
- type
- id
invocation:
description: >-
The invocation of this service, used to track which instance of a
service applied the metadata.
type: object
properties:
type:
description: The value will always be `skill_invocation`.
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
A 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: image-recognition-service-123
required:
- type
- id
entries:
description: An list of entries in the metadata card.
type: array
items:
type: object
description: An entry in the `entries` attribute of a metadata card.
properties:
text:
description: The text of the keyword.
type: string
example: keyword1
required:
- type
- skill_card_type
- skill
- invocation
- entries
title: Keyword Skill Card
x-box-resource-id: keyword_skill_card
x-box-tag: skills
TimelineSkillCard:
description: A Box Skill metadata card that places a list of images on a timeline.
type: object
properties:
created_at:
description: The optional date and time this card was created at.
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: The value will always be `skill_card`.
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: The value will always be `timeline`.
type: string
example: timeline
enum:
- timeline
skill_card_title:
description: The title of the card.
type: object
properties:
code:
description: An optional identifier for the title.
type: string
example: Faces
message:
description: The actual title to show in the UI.
type: string
example: Faces
required:
- message
skill:
description: The service that applied this metadata.
type: object
properties:
type:
description: The value will always be `service`.
type: string
example: service
enum:
- service
id:
description: >-
A custom identifier that represent the service that applied this
metadata.
type: string
example: image-recognition-service
required:
- type
- id
invocation:
description: >-
The invocation of this service, used to track which instance of a
service applied the metadata.
type: object
properties:
type:
description: The value will always be `skill_invocation`.
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
A 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: image-recognition-service-123
required:
- type
- id
duration:
description: An total duration in seconds of the timeline.
type: integer
example: 1000
entries:
description: A list of entries on the timeline.
type: array
items:
type: object
description: An single item that's placed on multiple items on the timeline.
properties:
text:
description: >-
The text of the entry. This would be the display name for an
item being placed on the timeline, for example the name of the
person who was detected in a video.
type: string
example: John
appears:
description: >-
Defines a list of timestamps for when this item should appear
on the timeline.
type: array
items:
type: object
description: The timestamp for an entry.
properties:
start:
description: >-
The time in seconds when an entry should start appearing
on a timeline.
type: integer
example: 1
end:
description: >-
The time in seconds when an entry should stop appearing
on a timeline.
type: integer
example: 20
required:
- start
- end
image_url:
description: >-
The image to show on a for an entry that appears on a
timeline. This image URL is required for every entry.
The image will be shown in a list of items (for example
faces), and clicking the image will show the user where that
entry appears during the duration of this entry.
type: string
example: https://example.com/image1.jpg
required:
- type
- skill_card_type
- skill
- invocation
- entries
title: Timeline Skill Card
x-box-resource-id: timeline_skill_card
x-box-tag: skills
TranscriptSkillCard:
description: A Box Skill metadata card that adds a transcript to a file.
type: object
properties:
created_at:
description: The optional date and time this card was created at.
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: The value will always be `skill_card`.
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: The value will always be `transcript`.
type: string
example: transcript
enum:
- transcript
skill_card_title:
description: The title of the card.
type: object
properties:
code:
description: An optional identifier for the title.
type: string
example: my_transcripts
message:
description: The actual title to show in the UI.
type: string
example: My Transcripts
required:
- message
skill:
description: The service that applied this metadata.
type: object
properties:
type:
description: The value will always be `service`.
type: string
example: service
enum:
- service
id:
description: >-
A custom identifier that represent the service that applied this
metadata.
type: string
example: transciption-service
required:
- type
- id
invocation:
description: >-
The invocation of this service, used to track which instance of a
service applied the metadata.
type: object
properties:
type:
description: The value will always be `skill_invocation`.
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
A 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: transciption-service-123
required:
- type
- id
duration:
description: |-
An optional total duration in seconds.
Used with a `skill_card_type` of `transcript` or `timeline`.
type: integer
example: 1000
entries:
description: >-
An list of entries for the card. This represents the individual
entries of the transcription.
type: array
items:
type: object
description: An entry in the `entries` attribute of a metadata card.
properties:
text:
description: >-
The text of the entry. This would be the transcribed text
assigned to the entry on the timeline.
type: string
example: Hi, and welcome to this video...
appears:
description: >-
Defines when a transcribed bit of text appears. This only
includes a start time and no end time.
type: array
items:
type: object
description: The timestamp for an entry.
properties:
start:
description: >-
The time in seconds when an entry should start appearing
on a timeline.
type: integer
example: 1
required:
- start
required:
- type
- skill_card_type
- skill
- invocation
- entries
title: Transcript Skill Card.
x-box-resource-id: transcript_skill_card
x-box-tag: skills
StatusSkillCard:
description: >-
A Box Skill metadata card that puts a status message in the metadata
sidebar.
type: object
properties:
created_at:
description: The optional date and time this card was created at.
type: string
format: date-time
example: '2018-04-13T13:53:23-07:00'
type:
description: The value will always be `skill_card`.
type: string
example: skill_card
enum:
- skill_card
skill_card_type:
description: The value will always be `status`.
type: string
example: status
enum:
- status
skill_card_title:
description: The title of the card.
type: object
properties:
code:
description: An optional identifier for the title.
type: string
example: status
message:
description: The actual title to show in the UI.
type: string
example: Status
required:
- message
status:
description: >-
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.
type: object
properties:
code:
description: >-
A 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.
type: string
example: success
enum:
- invoked
- processing
- success
- transient_failure
- permanent_failure
message:
description: >-
A custom message that can be provided with this status. This
will be shown in the web app to the end user.
type: string
example: We're preparing to process your file. Please hold on!
required:
- code
skill:
description: The service that applied this metadata.
type: object
properties:
type:
description: The value will always be `service`.
type: string
example: service
enum:
- service
id:
description: >-
A custom identifier that represent the service that applied this
metadata.
type: string
example: image-recognition-service
required:
- type
- id
invocation:
description: >-
The invocation of this service, used to track which instance of a
service applied the metadata.
type: object
properties:
type:
description: The value will always be `skill_invocation`.
type: string
example: skill_invocation
enum:
- skill_invocation
id:
description: >-
A 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: image-recognition-service-123
required:
- type
- id
required:
- type
- skill_card_type
- skill
- invocation
- status
title: Status Skill Card
x-box-resource-id: status_skill_card
x-box-tag: skills
securitySchemes:
OAuth2Security:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://account.box.com/api/oauth2/authorize
tokenUrl: https://api.box.com/oauth2/token
scopes:
root_readonly: Read all files and folders stored in Box
root_readwrite: Read and write all files and folders stored in Box
manage_app_users: Provision and manage app users
manage_managed_users: Provision and manage managed users
manage_groups: Manage an enterprise's groups
manage_webhook: Create webhooks programmatically through the API
manage_enterprise_properties: Manage enterprise properties
manage_data_retention: Manage data retention polices
manage_legal_hold: Manage Legal Holds
````