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

application/json

Path Parameters

stringin pathrequired
33243242

The ID of the skill invocation.

Request Body

objectin body

The file to assign this metadata to

stringnulloptional
3243244

The ID of the file

stringnulloptional
file

Value is always file

objectin body

The file version to assign this metadata to

stringnulloptional
3

The ID of the file version

stringnulloptional
file_version

Value is always file_version

objectin body

The metadata to set for this skill

object arraynulloptional

The metadata cards to set on the file.

string / date-timenullconditionally required
2012-12-12T10:53:43-08:00

The time the card was created at

integernulloptional
1000

An optional duration.

Used with a card_type oftranscript, or timeline.

object arraynulloptional

An optional list of entries.

Used with a card_type oftranscript, keyword or timeline.

stringnullconditionally required
keyword1

The text of the entry

stringnullconditionally required
text

Value is always text

The current invocation of the skill

stringnulloptional
33243242

The ID of the skill invocation.

stringnulloptional
skill_invocation

Value is always skill_invocation

objectnull

The skill that is updating the cards

stringnulloptional
43342423234

The ID of the skill.

stringnulloptional
service

Value is always service

The title of the card

stringnulloptional
my_transcripts

An identifier for your title

stringnulloptional
My Transcripts

The actual title to show in the UI

stringnulloptional
status

The type of card to create

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

objectnull

Optional status. Used with a card_type of status.

stringnulloptional
skills_pending_status

The type of status being set

Value is one of skills_pending_status,custom_error

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

The message for the status to show in the UI.

stringnullconditionally required
skill_card

Value is always skill_card

stringin bodyrequired
success

Sets the status of the skill invocation.

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

Response

none

Returns an empty response.

application/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.
Log in

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": {}
     }'