Episode
8 operations generated from the Engine OpenAPI schema. Request and response model names can be expanded in the interactive schema.
DELETE /api/v1/episodes/{id}
Delete the episode by ID.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | episode ID |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse |
GET /api/v1/episodes/{id}
Get the episode by ID.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | episode ID |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
PATCH /api/v1/episodes/{id}
Update the episode by ID.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | episode ID |
episode | body | app.Episode | Yes | Episode Data |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
DELETE /api/v1/episodes/{id}/logs
Delete episode logs.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | Episode ID |
Responses
| Status | Description | Schema |
|---|---|---|
204 | No Content | — |
GET /api/v1/episodes/{id}/logs
List episode logs.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | Episode ID |
after | query | integer | No | Log sequence cursor; values less than or equal to 0 return all logs |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | array of utils.LogEntry |
GET /api/v1/episodes/{id}/logs/download
Download episode logs.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | integer | Yes | Episode ID |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | file |
GET /api/v1/series/{id}/episodes
Get episodes by series ID.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | series ID |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |
POST /api/v1/series/{id}/episodes
Add the episode by series ID.
Authentication: Authorization header (ApiKeyAuth)
Parameters
| Name | Location | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | series ID |
episode | body | app.Episode | Yes | Episode Data |
Responses
| Status | Description | Schema |
|---|---|---|
200 | OK | route.APIResponse + object |