INinstructure
Professional captioning

Send the result of the caption file request.

This endpoint should be used to update a pending caption file request. Each request can be updated once with either fulfilled or failed status.

patch/caption_file_requests/{caption_file_request_id}

Request

  • Base URL
    https://tw.instructuremedia.com/api/public/v1
  • Auth
    API key in header Authorization

Path parameters

caption_file_request_idinteger required

The id of the caption file request to be updated.

Request body

status'processing' | 'fulfilled' | 'failed' required

Result of the file request.

messagestring

In case the caption creation was not successful you can provide some detail why it could not be completed.

caption_filestring

The file to be uploaded. The supported file extension is .srt!

Response

The results are successfully saved.

Changes

No recorded changes to this operation across all 1 revision of this API.