Update skill invocation

put

https://api.box.com/2.0

/skill_invocations/:skill_invocation_id

Updates the status, usage and response metadata of a skill invocation.

Request

Content-Typeapplication/json

Path Parameters

skill_invocation_id stringin pathrequired

example33243242

The ID of the skill invocation.

Request Body

file objectin body

The file to assign this metadata to

file.id stringnulloptional

example3243244

The ID of the file

file.type stringnulloptional

examplefile

Value is always file

file_version objectin body

The file version to assign this metadata to

file_version.id stringnulloptional

example3

The ID of the file version

file_version.type stringnulloptional

examplefile_version

Value is always file_version

metadata objectin body

The metadata to set for this skill

metadata.cardsobject arraynulloptional

The metadata cards to set on the file.

[cards.created_at] string / date-timenullconditionally required

example2012-12-12T10:53:43-08:00

The time the card was created at

[cards.duration] integernulloptional

example1000

An optional duration.

Used with a card_type oftranscript, or timeline.

[cards.entries]object arraynulloptional

An optional list of entries.

Used with a card_type oftranscript, keyword or timeline.

[entries.text] stringnullconditionally required

examplekeyword1

The text of the entry

[entries.type] stringnullconditionally required

exampletext

Value is always text

[cards.invocation] objectnull

The current invocation of the skill

invocation.id stringnulloptional

example33243242

The ID of the skill invocation.

invocation.type stringnulloptional

exampleskill_invocation

Value is always skill_invocation

[cards.skill] objectnull

The skill that is updating the cards

skill.id stringnulloptional

example43342423234

The ID of the skill.

skill.type stringnulloptional

exampleservice

Value is always service

[cards.skill_card_title] objectnull

The title of the card

skill_card_title.code stringnulloptional

examplemy_transcripts

An identifier for your title

skill_card_title.message stringnulloptional

exampleMy Transcripts

The actual title to show in the UI

[cards.skill_card_type] stringnulloptional

examplestatus

The type of card to create

Value is one of transcript,keyword,timeline,status,error

[cards.status] objectnull

Optional status. Used with a card_type of status.

status.code stringnulloptional

exampleskills_pending_status

The type of status being set

Value is one of skills_pending_status,custom_error

status.message stringnulloptional

exampleWe're preparing to process your file. Please hold on!

The message for the status to show in the UI.

[cards.type] stringnullconditionally required

exampleskill_card

Value is always skill_card

status stringin bodyrequired

examplesuccess

Sets the status of the skill invocation.

Value is one of invoked,processing,success,transient_failure,permanent_failure

Response

200none

Returns an empty response.

defaultapplication/jsonClient error

An unexpected client error.

put

Update skill invocation

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -X PUT https://api.box.com/2.0/skill_invocations/33243242 \
     -H 'Authorization: Bearer <ACCESS_TOKEN>'
     -H 'Content-Type: application/json" '
     -d '{
       "status": "success",
       "metadata": {},
       "file": {}
     }'