115 lines
4.5 KiB
Markdown
115 lines
4.5 KiB
Markdown
---
|
|
name: stream-routes
|
|
description: Handle 8 OpenAPI operation(s) under /api/v1/stream for the stream route group.
|
|
---
|
|
|
|
# stream API Routes
|
|
|
|
Handle 8 OpenAPI operation(s) under /api/v1/stream for the stream route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### stream_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_fil
|
|
|
|
- Operation ID: `stream_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_fil`
|
|
- Route: `GET /api/v1/stream/video/{org_uuid}/{course_uuid}/{activity_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Stream an activity video
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `course_uuid` in `path` required
|
|
- `activity_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### head_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_filen
|
|
|
|
- Operation ID: `head_activity_video_api_v1_stream_video_org_uuid_course_uuid_activity_uuid_filen`
|
|
- Route: `HEAD /api/v1/stream/video/{org_uuid}/{course_uuid}/{activity_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Get activity video metadata
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `course_uuid` in `path` required
|
|
- `activity_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### stream_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_
|
|
|
|
- Operation ID: `stream_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_`
|
|
- Route: `GET /api/v1/stream/block/audio/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Stream an audio block file
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `course_uuid` in `path` required
|
|
- `activity_uuid` in `path` required
|
|
- `block_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### head_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_bl
|
|
|
|
- Operation ID: `head_block_audio_api_v1_stream_block_audio_org_uuid_course_uuid_activity_uuid_bl`
|
|
- Route: `HEAD /api/v1/stream/block/audio/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Get audio block file metadata
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `course_uuid` in `path` required
|
|
- `activity_uuid` in `path` required
|
|
- `block_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### stream_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_
|
|
|
|
- Operation ID: `stream_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_`
|
|
- Route: `GET /api/v1/stream/block/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Stream a video block file
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `course_uuid` in `path` required
|
|
- `activity_uuid` in `path` required
|
|
- `block_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### head_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_uu
|
|
|
|
- Operation ID: `head_block_video_api_v1_stream_block_org_uuid_course_uuid_activity_uuid_block_uu`
|
|
- Route: `HEAD /api/v1/stream/block/{org_uuid}/{course_uuid}/{activity_uuid}/{block_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Get video block file metadata
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `course_uuid` in `path` required
|
|
- `activity_uuid` in `path` required
|
|
- `block_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### stream_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_file
|
|
|
|
- Operation ID: `stream_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_file`
|
|
- Route: `GET /api/v1/stream/audio/{org_uuid}/{podcast_uuid}/{episode_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Stream a podcast episode audio
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `podcast_uuid` in `path` required
|
|
- `episode_uuid` in `path` required
|
|
- `filename` in `path` required
|
|
|
|
### head_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_filena
|
|
|
|
- Operation ID: `head_podcast_audio_api_v1_stream_audio_org_uuid_podcast_uuid_episode_uuid_filena`
|
|
- Route: `HEAD /api/v1/stream/audio/{org_uuid}/{podcast_uuid}/{episode_uuid}/{filename}`
|
|
- Mode: READ
|
|
- Summary: Get podcast audio metadata
|
|
- Parameters:
|
|
- `org_uuid` in `path` required
|
|
- `podcast_uuid` in `path` required
|
|
- `episode_uuid` in `path` required
|
|
- `filename` in `path` required
|