ID3 Tags

ID3 Tags are metadata containers to store information about the media. Clients can perform a POST operation via API endpoint <bakery-host>/api/v1/id3-tag-inspect to start an ID3 Tag inspection job. This job will analyze all segments from a HLS or DASH ad-pod manifest to find any embedded ID3 tags and return its details.

Inspect ID3 Tag Request Object

Name Type Required Description
stream_id string yes unique stream ID to fetch ad pod response data

Example Requests

Create inspect ID3 tag job

# request
curl -X POST 'https://bakery.dev.cbsivideo.com/api/v1/id3-tag-inspect' \
--header 'Content-Type: application/json' 
--header 'Authorization: <<Bearer Token>>'
--data '{
    "stream_id": "<Stream ID>"
}'

# response
{
    "stream_id": "<Stream ID>",
    "status": "pending",
    "ad_pods": null,
    "created": "2025-05-08T15:47:49.217658-07:00"
}

If inspection is complete, return the results

# request
curl -X POST 'https://bakery.dev.cbsivideo.com/api/v1/id3-tag-inspect' \
--header 'Content-Type: application/json' 
--header 'Authorization: <<Bearer Token>>'
--data '{
    "stream_id": "<Stream ID>"
}'

# response
{
    "stream_id": "<Stream ID>",
    "status": "complete",
    "ad_pods": [
        {
            "break": 0,
            "start_time_sec": 0,
            "dash": [
                {
                    "name": "period-id-0:0.0.0.1995354457-ad-1",
                    "rendtions": [
                        {
                            "name": "rendition-id-0:video_avc1.4D401E_200000_384_216",
                            "segments": [
                                {
                                    "name": "segment-id-1",
                                    "tags": [
                                        {
                                            "value": "google_7780516655954641591",
                                            "metadata": {
                                                "timescale": 1000,
                                                "presentation_time": 100
                                            }
                                        }
                                    ]
                                    ...