Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. By signing up you are subscribing to the APIs.io and API Evangelist
newsletters — you can unsubscribe from any issue. See our
Privacy Policy and Terms.
openapi: 3.2.0
info:
title: Open edX Val API
description: APIs for access to Open edX information
contact:
email: contact@academy.dhis2.org
version: v1
servers:
- url: https://academy.dhis2.org/api
security:
- Basic: []
tags:
- name: val
paths:
/val/v0/videos/:
parameters: []
get:
operationId: val_v0_videos_list
description: GETs or POST video objects
parameters:
- name: page
in: query
description: A page number within the paginated result set.
required: false
schema:
type: integer
- name: page_size
in: query
description: Number of results to return per page.
required: false
schema:
type: integer
responses:
'200':
description: ''
content:
application/json:
schema:
required:
- count
- results
type: object
properties:
count:
type: integer
next:
type:
- string
- 'null'
format: uri
previous:
type:
- string
- 'null'
format: uri
results:
type: array
items:
$ref: '#/components/schemas/Video'
tags:
- val
summary: Val v0 videos list
x-summary-source: derived
post:
operationId: val_v0_videos_create
description: GETs or POST video objects
responses:
'201':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
tags:
- val
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
required: true
summary: Val v0 videos create
x-summary-source: derived
/val/v0/videos/course-transcripts/{course_id}/:
parameters:
- name: course_id
in: path
required: true
schema:
type: string
get:
operationId: val_v0_videos_course-transcripts_read
description: Returns all transcript data for a course when given a course_id.
responses:
'200':
description: ''
tags:
- val
summary: Val v0 videos course transcripts read
x-summary-source: derived
/val/v0/videos/courses/{course_id}/video-ids:
parameters:
- name: course_id
in: path
required: true
schema:
type: string
get:
operationId: val_v0_videos_courses_video-ids_list
description: Returns all video_ids for a course when given a course_id.
responses:
'200':
description: ''
tags:
- val
summary: Val v0 videos courses video ids list
x-summary-source: derived
/val/v0/videos/missing-hls/:
parameters: []
post:
operationId: val_v0_videos_missing-hls_create
summary: Retrieve video IDs that are missing HLS profiles.
description: '1. If we want a batch of video ids which are missing HLS profile irrespective of their courses, the request
data should be in following format:
{
''batch_size'': 50,
''offset'': 0
}
And response will be in following format:
{
''videos'': [''video_id1'', ''video_id2'', ''video_id3'', ... , video_id50],
''total'': 300,
''offset'': 50,
''batch_size'': 50
}
2. If we want all the videos which are missing HLS profiles in a set of specific courses, the request data
should be in following format:
{
''courses'': [
''course_id1'',
''course_id2'',
...
]
}
And response will be in following format:
{
''videos'': [''video_id1'', ''video_id2'', ''video_id3'', ...]
}'
responses:
'201':
description: ''
tags:
- val
put:
operationId: val_v0_videos_missing-hls_update
summary: Update a single profile for a given video
description: 'Example request data:
```
{
''edx_video_id'': ''1234''
''profile'': ''hls'',
''encode_data'': {
''url'': ''foo.com/qwe.m3u8''
''file_size'': 34
''bitrate'': 12
}
}
```'
responses:
'200':
description: ''
tags:
- val
/val/v0/videos/status/:
parameters: []
patch:
operationId: val_v0_videos_status_partial_update
description: Update the status of a video.
responses:
'200':
description: ''
tags:
- val
summary: Val v0 videos status partial update
x-summary-source: derived
/val/v0/videos/video-images/update/:
parameters: []
post:
operationId: val_v0_videos_video-images_update_create
description: Update a course video image instance with auto generated image names.
responses:
'201':
description: ''
tags:
- val
summary: Val v0 videos video images update create
x-summary-source: derived
/val/v0/videos/video-transcripts/:
parameters: []
post:
operationId: val_v0_videos_video-transcripts_create
description: Creates a video transcript instance with the given information.
responses:
'201':
description: ''
tags:
- val
summary: Val v0 videos video transcripts create
x-summary-source: derived
patch:
operationId: val_v0_videos_video-transcripts_partial_update
description: Partially update a video transcript, only supporting updating the `provider` field.
responses:
'200':
description: ''
tags:
- val
summary: Val v0 videos video transcripts partial update
x-summary-source: derived
delete:
operationId: val_v0_videos_video-transcripts_delete
description: Delete a video transcript instance with the given information.
responses:
'204':
description: ''
tags:
- val
summary: Val v0 videos video transcripts delete
x-summary-source: derived
/val/v0/videos/video-transcripts/create/:
parameters: []
post:
operationId: val_v0_videos_video-transcripts_create_create
description: Creates a video transcript instance with the given information.
responses:
'201':
description: ''
tags:
- val
summary: Val v0 videos video transcripts create create
x-summary-source: derived
patch:
operationId: val_v0_videos_video-transcripts_create_partial_update
description: Partially update a video transcript, only supporting updating the `provider` field.
responses:
'200':
description: ''
tags:
- val
summary: Val v0 videos video transcripts create partial update
x-summary-source: derived
delete:
operationId: val_v0_videos_video-transcripts_create_delete
description: Delete a video transcript instance with the given information.
responses:
'204':
description: ''
tags:
- val
summary: Val v0 videos video transcripts create delete
x-summary-source: derived
/val/v0/videos/{edx_video_id}:
parameters:
- name: edx_video_id
in: path
required: true
schema:
type: string
pattern: ^[a-zA-Z0-9\-_]*$
get:
operationId: val_v0_videos_read
description: Gets a video instance given its edx_video_id
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
tags:
- val
summary: Val v0 videos read
x-summary-source: derived
put:
operationId: val_v0_videos_update
description: Gets a video instance given its edx_video_id
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
tags:
- val
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
required: true
summary: Val v0 videos update
x-summary-source: derived
patch:
operationId: val_v0_videos_partial_update
description: Gets a video instance given its edx_video_id
responses:
'200':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
tags:
- val
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Video'
required: true
summary: Val v0 videos partial update
x-summary-source: derived
delete:
operationId: val_v0_videos_delete
description: Gets a video instance given its edx_video_id
responses:
'204':
description: ''
tags:
- val
summary: Val v0 videos delete
x-summary-source: derived
components:
schemas:
Video:
required:
- encoded_videos
- edx_video_id
- duration
- status
type: object
properties:
encoded_videos:
type: array
items:
$ref: '#/components/schemas/EncodedVideo'
courses:
type: array
items:
type: string
uniqueItems: true
url:
title: Url
type: string
readOnly: true
created:
title: Created
type: string
format: date-time
edx_video_id:
title: Edx video id
type: string
pattern: ^[a-zA-Z0-9\-_]*$
maxLength: 100
minLength: 1
client_video_id:
title: Client video id
type: string
maxLength: 255
duration:
title: Duration
type: number
minimum: 0
status:
title: Status
type: string
maxLength: 255
minLength: 1
error_description:
title: Error Description
type:
- string
- 'null'
EncodedVideo:
required:
- url
- file_size
- bitrate
- profile
type: object
properties:
created:
title: Created
type: string
format: date-time
modified:
title: Modified
type: string
format: date-time
url:
title: Url
type: string
maxLength: 200
minLength: 1
file_size:
title: File size
type: integer
minimum: 0
bitrate:
title: Bitrate
type: integer
minimum: 0
profile:
title: Profile
type: string
pattern: ^[a-zA-Z0-9\-_]*$
securitySchemes:
Basic:
type: http
scheme: basic