Get video transcription status
Get the transcription status of the video asset.
URL: POST /api/v1/assets/video/cc/generate/status
Note: If not successful, /creatives/preview will fail even though POST/PUT/PATCH will succeed and this will prevent /creatives/submit.
Request Parameters
| Parameter | Description | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | The ID of the specific advertiser | integer | Y | A valid advertiser Id |
| assetId | The ID of the video asset | uuid | Y | A valid asset Id |
| captioningJobId | Id of the captioning job | uuid | Y |
Sample Request
curl -X POST \
'https://developer.api.us.stg.walmart.com/api-proxy/service/display/api/v1/api/v1/assets/video/cc/generate/status' \
--header 'Content-Type: multipart/form-data'\
--header 'Authorization: Bearer <auth_token>'
--header 'WM_SEC.AUTH_SIGNATURE: **************' \
--header 'WM_SEC.KEY_VERSION: 1' \
--header 'WM_CONSUMER.ID: adfwe-v00-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header "X-Advertiser-ID: 00000" \
--data '{ "advertiserId": 00000000, "assetId": "00000000", "captioningJobId": "00000000" }'
Response
| Element | Description | Type |
|---|---|---|
captioningJobId | Unique ID for the captioning job. | string (UUID) |
assetId | Unique ID of the associated media asset. | string (UUID) |
profileName | Name of the profile used for captioning (e.g., "checkin"). | string |
status | Current status of the captioning job. Possible values: COMPLETED, IN_PROGRESS, SUBMITTED, FAILED. | string (enum) |
statusCode | Additional status information, e.g., "NO_SPEECH_DETECTED" or null. | string or null |
description | Description or summary of the captioning job. | string |
createdAt | Timestamp when the job was created, in ISO 8601 format. | string |
updatedAt | Timestamp when the job was last updated, in ISO 8601 format. | string |
type | Type of captioning operation; always "CLOSED_CAPTIONS". | string |
name | Name assigned to the caption file. | string |
extension | File extension of the caption file, typically "vtt". | string |
origin | Source system or service that generated the captions. | string |
autoGenerated | Indicates whether captions were generated automatically. | boolean |
content | VTT file content containing caption text (only present if status = COMPLETED). | string |
errorMessage | Error message if the captioning job failed; null if successful. | string or null |
code | Code indicating overall result of the operation (e.g., "success"). | string |
details | List of additional result details (e.g., ["success"]). | array |
Sample Response
{ "captioningJobId": "abcdef-12345", "assetId": "abcdef-12345", "profileName": "checkin", "status": "COMPLETED", "statusCode": "NO_SPEECH_DETECTED", "description": "Captioning job completed successfully.", "createdAt": "2025-10-30T10:15:30Z", "updatedAt": "2025-10-30T10:45:00Z", "type": "CLOSED_CAPTIONS", "name": "checkin_captions", "extension": "vtt", "origin": "TRANSCRIBE", "autoGenerated": true, "content": "WEBVTT\n\n00:00:00.000 --> 00:00:02.000\nExample caption\n\n00:00:02.500 --> 00:00:04.000\nExample caption", "errorMessage": null, "code": "success", "details": ["success"]
} Updated 2 days ago