> ## Documentation Index
> Fetch the complete documentation index at: https://lingopal.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Launch Media Pipeline (RTMP Channel)

> Launch a media pipeline by creating an RTMP channel.

## Description

This endpoint is used to create a new RTMP channel. It returns the RTMP server URL and stream key, which you will use in your streaming software (such as OBS Studio) to broadcast your stream. After creating the channel, use the Launch Stream endpoint to start the RTMP stream. See the Quickstart guide for the full workflow.

## Authentication

This endpoint requires an API Key.\
Include your API key in the `X-Api-Key` header:

```http theme={null}
X-Api-Key: your x-api-key
```

## Request

* **Method:** POST
* **Endpoint:** `/v1/rtmp_channel`
* **Content-Type:** `application/json`

### Request Body

```json theme={null}
{
  "output_rtmp_url": "string",
  "output_stream_key": "string"
}
```

| Field               | Type   | Required | Description                |
| ------------------- | ------ | -------- | -------------------------- |
| output\_rtmp\_url   | string | Yes      | The RTMP output URL        |
| output\_stream\_key | string | Yes      | The RTMP output stream key |

### Request Body Parameters

| Field               | Type   | Required | Description                                 |
| ------------------- | ------ | -------- | ------------------------------------------- |
| output\_rtmp\_url   | string | Yes      | The RTMP output URL for the channel.        |
| output\_stream\_key | string | Yes      | The RTMP output stream key for the channel. |

## Response

* **Status:** 200 OK
* **Content-Type:** `application/json`

```json theme={null}
{
  // Response fields here (add example if you have one)
}
```

## Example Usage (cURL)

```bash theme={null}
curl -X POST "https://your-api-domain.com/v1/rtmp_channel" \
  -H "X-Api-Key: your x-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "output_rtmp_url": "rtmp://example.com/live",
    "output_stream_key": "your-stream-key"
  }'
```


## OpenAPI

````yaml POST /v1/rtmp_channel
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  x-ignore-stats:
    get:
      summary: Get Translation Statistics
      description: Get translation statistics for a stream.
      security:
        - ApiKeyAuth: []
      parameters:
        - name: stream_id
          in: path
          description: Stream ID
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_translations:
                    type: integer
                  edited_translations:
                    type: integer
                  unique_languages:
                    type: array
                    items:
                      type: string
                  edit_percentage:
                    type: number
                  language_stats:
                    type: object
                    additionalProperties: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
                    items:
                      type: object
                      properties:
                        loc:
                          type: array
                          items:
                            type: string
                        msg:
                          type: string
                        type:
                          type: string
  x-translations-temp:
    get:
      summary: Get Translations
      description: Get paginated translations for a stream.
      security:
        - ApiKeyAuth: []
      parameters:
        - name: stream_id
          in: path
          description: Stream ID
          required: true
          schema:
            type: string
        - name: page
          in: query
          description: Page number
          required: false
          schema:
            type: integer
            default: 1
        - name: per_page
          in: query
          description: Items per page
          required: false
          schema:
            type: integer
            default: 50
        - name: order
          in: query
          description: 'Sort order: ''asc'' for oldest first, ''desc'' for latest first'
          required: false
          schema:
            type: string
            default: desc
        - name: language_id
          in: query
          description: Filter by language ID
          required: false
          schema:
            type: string
        - name: edited
          in: query
          description: Filter by edit status
          required: false
          schema:
            type: boolean
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  translations:
                    type: array
                    items:
                      type: object
                      properties:
                        stream_id:
                          type: string
                        language_id:
                          type: string
                        segment_id:
                          type: integer
                        timestamp:
                          type: string
                        end_time:
                          type: string
                        original_content:
                          type: string
                        speaker:
                          type: string
                        id:
                          type: integer
                        content:
                          type: string
                        edited:
                          type: boolean
                        created_at:
                          type: string
                        updated_at:
                          type: string
                  total:
                    type: integer
                  page:
                    type: integer
                  per_page:
                    type: integer
                  has_next:
                    type: boolean
                  has_prev:
                    type: boolean
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: array
                    items:
                      type: object
                      properties:
                        loc:
                          type: array
                          items:
                            type: string
                        msg:
                          type: string
                        type:
                          type: string
  version: 1.0.0
servers:
  - url: https://streaming.lingopal.ai
  - url: https://streaming.lingopal-dev.com
security:
  - ApiKeyAuth: []
paths:
  /v1/rtmp_channel:
    post:
      summary: Launch Media Pipeline (RTMP Channel)
      description: Launch a media pipeline by creating an RTMP channel.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                output_rtmp_url:
                  type: string
                output_stream_key:
                  type: string
              required:
                - output_rtmp_url
                - output_stream_key
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key

````