Instructure Developer Documentation Portal

Captions

PreviousAPI Reference NextCollection

Last updated 1 day ago

Was this helpful?

Download a caption by id

get

Authorizations

Path parameters

caption_file_idinteger · int64Required

The ID of the caption.

Responses

200

The caption file itself

401

Authorization information is missing or invalid.

403

If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.

404

The caption was not found by id.

422

Invalid caption_file_id is provided.

get

GET /api/public/v1/caption_files/{caption_file_id}/download HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*

No content

List all available captions for the given media

get

Authorizations

Path parameters

media_idinteger · int64Required

The ID of the media.

Responses

200

The list of captions that are available for the media.

application/json

401

Authorization information is missing or invalid.

403

If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.

404

The media was not found by ID.

422

Invalid media_id is provided.

get

GET /api/public/v1/media/{media_id}/caption_files HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "caption_files": [
    {
      "id": 1,
      "url": "text",
      "srclang": "text",
      "subtitle_format": "text",
      "label": "text",
      "status": "text",
      "created_at": "2025-05-16T02:09:06.414Z"
    }
  ]
}

Create a new caption for the given media

post

Authorizations

Path parameters

media_idinteger · int64Required

The ID of the media.

Query parameters

srclangstringRequired

The language of the caption.

Body

{:name=>:caption_file, :description=>"The file to be uploaded.", :schema=>{:type=>:file}}anyOptional

Responses

201

The caption object that was created.

application/json

401

Authorization information is missing or invalid.

403

If a user without proper permissions tries to call this endpoint, the call is rejected with 403 Forbidden.

404

The media was not found by ID.

422

Invalid media_id is provided.

post

POST /api/public/v1/media/{media_id}/caption_files HTTP/1.1
Host: tw.instructuremedia.com
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 100

{
  "{:name=>:caption_file, :description=>\"The file to be uploaded.\", :schema=>{:type=>:file}}": null
}

{
  "caption_file": {
    "id": 1,
    "url": "text",
    "srclang": "text",
    "subtitle_format": "text",
    "label": "text",
    "status": "text",
    "created_at": "2025-05-16T02:09:06.414Z"
  }
}