---
updatedAt: 2026-06-16T14:01:28.000Z
agentTools:
projectIndex: https://docs.3playmedia.dev/llms.txt
---
# List Live Professional Captions
List live professional captioning details in the project
# OpenAPI definition
```json
{
"openapi": "3.0.3",
"info": {
"title": "3Play V3 API",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"description": "Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.",
"version": "3.0.1"
},
"security": [
{
"api_key": []
}
],
"servers": [
{
"url": "https://api.3playmedia.com/v3",
"description": "3Play Production"
},
{
"url": "https://api.3pmstaging.com/v3",
"description": "3Play Staging"
}
],
"components": {
"securitySchemes": {
"api_key": {
"type": "apiKey",
"name": "api_key",
"in": "query"
}
},
"schemas": {
"ListLiveProfessionalCaptioning": {
"type": "object",
"properties": {
"code": {
"$ref": "#/components/schemas/status_code_success"
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LiveProfessionalCaptioning"
}
},
"pagination": {
"$ref": "#/components/schemas/pagination"
},
"meta": {
"$ref": "#/components/schemas/meta"
}
}
},
"LiveProfessionalCaptioning": {
"type": "object",
"properties": {
"id": {
"$ref": "#/components/schemas/id"
},
"media_file_id": {
"type": "integer",
"format": "int32",
"description": "ID of the live professional captioning event's media file",
"example": 1234
},
"start_time": {
"type": "string",
"description": "Scheduled start time of the captioning event",
"example": "2023-02-23T00:58:10-05:00"
},
"event_wait_time": {
"type": "integer",
"format": "integer",
"description": "Amount of time (in minutes) after start_time our system waits before failing the event if no audio is detected",
"example": 30
},
"event_max_time": {
"type": "integer",
"format": "integer",
"description": "Maximum time (in minutes) of captioning event, including breaks and delays. Event is auto-finished at this time if not finished sooner.",
"example": 240
},
"threeplay_transcript_id": {
"type": "integer",
"format": "integer",
"description": "ID of the transcript produced by the captioning event. Used for downloading the completed transcript.",
"example": 27343221
},
"language_id": {
"type": "integer",
"format": "integer",
"description": "ID of the language of the media file",
"example": 1
},
"embed_code": {
"type": "string",
"description": "iFrame embed code for the live professional caption plugin",
"example": ""
},
"js_embed_code": {
"type": "string",
"description": "Javascript embed code for the live professional caption plugin",
"example": "\n\n"
},
"external_webpage_with_captions_url": {
"type": "string",
"description": "Externally hosted webpage with captions for the event. Pass 'static_embed_key_code' upon creation to obtain a static URL.",
"example": "https://p3.3playmedia.com/live-asr-client-v1/external_webpage_with_captions.html?key=bhilFHxPE1QJ&show_complete_transcript=true&stream_start=1677131890&use_uppercase=0"
},
"public_id": {
"type": "string",
"description": "Custom ID of the live professional caption, which can be used to modify an existing plugin",
"example": "bhilFHxPE1QJ"
},
"status": {
"type": "string",
"description": "Status of the captioning event",
"example": "scheduled"
},
"stream_url": {
"type": "string",
"description": "Stream URL the live stream consumes. Must begin with 'rtmp'.",
"example": "rtmp://1fcb74f5cadf.entrypoint.cloud.wowza.com/app-22dj1pT6/de9145b1"
},
"latency": {
"type": "integer",
"description": "Target delay (in milliseconds) before the live captions are available. More delay generally allows increased accuracy.",
"example": 2000
},
"offensive_words_sensitivity": {
"type": "integer",
"format": "integer",
"description": "Sensitivity for eliding words. Higher is more sensitive.",
"example": 1,
"enum": [
0,
1,
2,
3
]
},
"cancellable": {
"type": "boolean",
"description": "Whether the captioning event can be updated or cancelled",
"example": true
},
"stream_reconnection_wait_time": {
"type": "integer",
"format": "integer",
"description": "How long (in minutes) 3Play waits before ending the event if your stream disconnects. Once disconnected, you cannot reconnect to this event and must schedule a new event in 3Play to continue captions.",
"example": 0
},
"meeting_location": {
"type": "string",
"description": "URL or phone number of the event audio for captioner access",
"example": "https://join-test.webex.com/wbxmjs/"
},
"captioner_join_time": {
"type": "string",
"description": "Time the 3Play Professional Captioner will join the event",
"example": "2023-02-23T00:58:10-05:00"
}
}
},
"id": {
"type": "integer",
"description": "Generated ID"
},
"meta": {
"type": "object",
"properties": {
"project": {
"type": "string",
"example": "Using sandbox project"
}
}
},
"pagination": {
"type": "object",
"properties": {
"page": {
"type": "integer",
"format": "int32",
"example": 1
},
"per_page": {
"type": "integer",
"format": "int32",
"example": 25
},
"total_entries": {
"type": "integer",
"format": "int32",
"example": 15
}
}
},
"status_code_success": {
"type": "integer",
"format": "int32",
"description": "Status Code",
"example": 200
}
}
},
"paths": {
"/live_professional_captions": {
"get": {
"tags": [
"Live Professional Captioning"
],
"summary": "List Live Professional Captions",
"description": "List live professional captioning details in the project",
"operationId": "listLiveProfessionalCaptions",
"parameters": [
{
"in": "query",
"name": "id",
"schema": {
"type": "integer"
},
"description": "Filter by ID"
},
{
"in": "query",
"name": "media_file_id",
"schema": {
"type": "integer"
},
"description": "Filter by media file ID"
},
{
"in": "query",
"name": "threeplay_transcript_id",
"schema": {
"type": "integer"
},
"description": "Filter by transcript ID"
},
{
"in": "query",
"name": "public_id",
"schema": {
"type": "integer"
},
"description": "Filter by public ID"
},
{
"in": "query",
"name": "status",
"schema": {
"type": "string",
"enum": [
"scheduled",
"in_progress",
"finished",
"archived",
"cancelled"
]
},
"description": "Filter by status"
},
{
"in": "query",
"name": "start_before",
"schema": {
"type": "string"
},
"description": "Filter by start date before specified date and time"
},
{
"in": "query",
"name": "start_after",
"schema": {
"type": "string"
},
"description": "Filter by start date after specified date and time"
},
{
"in": "query",
"name": "created_before",
"schema": {
"type": "string"
},
"description": "Filter by create date before specified date and time"
},
{
"in": "query",
"name": "created_after",
"schema": {
"type": "string"
},
"description": "Filter by create date after specified date and time"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ListLiveProfessionalCaptioning"
}
}
}
},
"400": {
"description": "Unauthorized"
}
}
}
}
}
}
```