# Getting start with custom fields
# Getting custom fields from a video
When getting a video, the response will include simpleCustomFields field,
the include all fields from the custom field section.
# Endpoint
GET https://stream.byteark.com/api/v1/videos/<videoKey>
1
# Example Response
Response will include custom fields in a key/value style, using "field name" as key.
TIP
Some response body that not related with custom fields are redacted
{
"videoKey": "<videoKey>",
"simpleCustomFields": {
"note": "This should be popular",
"episode_no": 1,
"recommended": true,
"reviewed_at": "2025-02-10T00:00:00Z",
"content_type": ["test"]
}
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# Updating custom fields to a video, with simpleCustomFields
For some programming languages, the easiest way to update as using simpleCustomFields
Request Endpoint:
PUT https://stream.byteark.com/api/v1/videos/<videoKey>/custom-fields
1
Request body:
{
"simpleCustomFields": {
"note": "Sample video",
"content_type": ["test"],
"recommended": true,
"reviewed_at": "2025-02-10T00:00:00Z",
"episode_no": 1
}
}
1
2
3
4
5
6
7
8
9
2
3
4
5
6
7
8
9
Response:
TIP
Some response body that not related with custom fields are redacted
{
"videoKey": "<videoKey>",
"simpleCustomFields": {
"note": "This should be popular",
"episode_no": 1,
"recommended": true,
"reviewed_at": "2025-02-10T00:00:00Z",
"content_type": ["test"]
}
}
1
2
3
4
5
6
7
8
9
10
2
3
4
5
6
7
8
9
10
# Learn more
# Custom field types
Custom field has various data types, you may learn more about all data types on field types
# Other formats
Instead of simpleCustomFields, you may want to use custom fields with other formats.
You may learn more about this on advance topics