Reference
Find Chapters
GET/v5/chapter/:mediaContainerId
Find all chapters for a given mediacontainerId
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| mediaContainerId | integer | ✓ | Return chapters for the given mediaContainerId |
Response
| Field | Type | Description |
|---|---|---|
| createdAt | dateTime | Date and time of the creation |
| creatorId | integer | User id of the creator if this chapter |
| description | string | Description for this chapter |
| id | integer | Id of the chapter |
| mediaContainerId | integer | mediaContainerId this chapter is related to. |
| mediaId | integer | If set, this mediaId represents the preview image for this chapter. |
| published | boolean | If true, this chapter is available for external weblinks |
| startTime | float | startTime of this caption |
| title | string | Title for this chapter |
| updatedAt | dateTime | Date and time of the latest update |
Examples
Find chapters
Request
/v5/chapter
Response
{
"body": [
{
"title": "Chapter 1",
"description": "Description for chapter 1",
"startTime": 30.5,
"mediaContainerId": 123,
"mediaId": 456,
"published": true,
"id": 1,
"creatorId": 789,
"createdAt": "2025-10-01T12:00:00Z",
"updatedAt": "2025-10-02T12:00:00Z"
}
]
}Create Chapters
POST/v5/chapter
Creates a new caption for a given subtitle. Checks the start and endTime against the original media duration.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | ✗ | Description for this chapter |
| mediaContainerId | integer | ✓ | mediaContainerId this chapter is related to. |
| mediaId | integer | ✗ | If set, this mediaId represents the preview image for this chapter. |
| published | boolean | ✗ | If true, this chapter is available for external weblinks |
| startTime | float | ✓ | startTime of this caption |
| title | string | ✓ | Title for this chapter |
Response
| Field | Type | Description |
|---|---|---|
| createdAt | dateTime | Date and time of the creation |
| creatorId | integer | User id of the creator if this chapter |
| description | string | Description for this chapter |
| id | integer | Id of the chapter |
| mediaContainerId | integer | mediaContainerId this chapter is related to. |
| mediaId | integer | If set, this mediaId represents the preview image for this chapter. |
| published | boolean | If true, this chapter is available for external weblinks |
| startTime | float | startTime of this caption |
| title | string | Title for this chapter |
| updatedAt | dateTime | Date and time of the latest update |
Examples
Create chapters (simple)
Request
/v5/chapter
{
"title": "Chapter 1",
"startTime": 30.5,
"mediaContainerId": 123,
"published": true
}Response
{
"body": [
{
"title": "Chapter 1",
"description": "Description for chapter 1",
"startTime": 30.5,
"mediaContainerId": 123,
"published": true,
"id": 1,
"creatorId": 789,
"createdAt": "2025-10-01T12:00:00Z",
"updatedAt": "2025-10-02T12:00:00Z"
}
]
}Update Chapters
PUT/v5/chapter/:mediaContainerId/:id
Creates a new caption for a given subtitle. Checks the start and endTime against the original media duration.
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| description | string | ✗ | Description for this chapter |
| id | integer | ✓ | Id of the chapter you want to update |
| mediaContainerId | integer | ✓ | mediaContainerId this chapter is related to. |
| mediaId | integer | ✗ | If set, this mediaId represents the preview image for this chapter. |
| published | boolean | ✗ | If true, this chapter is available for external weblinks |
| startTime | float | ✗ | startTime of this caption you want to update |
| title | string | ✗ | Title for this chapter |
Response
| Field | Type | Description |
|---|---|---|
| createdAt | dateTime | Date and time of the creation |
| creatorId | integer | User id of the creator if this chapter |
| description | string | Description for this chapter |
| id | integer | Id of the chapter |
| mediaContainerId | integer | mediaContainerId this chapter is related to. |
| mediaId | integer | If set, this mediaId represents the preview image for this chapter. |
| published | boolean | If true, this chapter is available for external weblinks |
| startTime | float | startTime of this caption |
| title | string | Title for this chapter |
| updatedAt | dateTime | Date and time of the latest update |
Examples
Update chapters
Request
/v5/chapter/1
{
"title": "Chapter 1 updated",
"startTime": 45,
"mediaContainerId": 123
}Response
{
"body": [
{
"title": "Chapter 1 updated",
"description": "Description for chapter 1",
"startTime": 45,
"mediaContainerId": 123,
"published": true,
"id": 1,
"creatorId": 789,
"createdAt": "2025-10-01T12:00:00Z",
"updatedAt": "2025-10-02T14:00:00Z"
}
]
}Delete Chapters
DELETE/v5/chapter/:mediaContainerId/:id
Destroys as chapter for a given mediaContainer
Request Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | integer | ✓ | Id of the chapter you want to delete |
| mediaContainerId | integer | ✓ | mediaContainerId this chapter is related to. |
Response
| Field | Type | Description |
|---|---|---|
| id | integer | Id of the chapter |