postlake-dev Live Video API

openapi: 3.2.0
info:
  title: PostLake Live Video API
  version: 1.0.0
  description: Unified social media API. One API key, 10 platforms, normalised responses. Built for agents and developers.
  contact:
    url: https://postlake.dev
servers:
- url: https://api.postlake.dev
security:
- bearerAuth: []
tags:
- name: Live Video
  description: Create and manage Facebook Page live broadcasts
paths:
  /v1/social-accounts/{id}/live-broadcasts:
    get:
      tags:
      - Live Video
      summary: List Facebook Page live broadcasts
      description: Lists current and recent broadcasts from Facebook. It never returns an ingest URL or stream key.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
      responses:
        '200':
          description: Success
      operationId: getV1SocialAccountsByIdLiveBroadcasts
      x-operation-id-source: derived
    post:
      tags:
      - Live Video
      summary: Create a Facebook Page live broadcast
      description: Prepares a Facebook Page broadcast. Facebook returns a one-time secure ingest URL, and may return a separate stream key, for compatible streaming software. PostLake never stores either value. Start the encoder, then call the start endpoint to make it live. Preparing is free; a credit is used only after Facebook confirms the broadcast is live. Meta independently requires the Facebook account managing the Page to be at least 60 days old, the Page to have at least 100 followers, and the person connecting it to have Page-management permission. PostLake cannot override those checks.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              properties:
                title:
                  type: string
                description:
                  type: string
      responses:
        '201':
          description: 'Created. Save the ingest credentials now: they cannot be read later.'
      operationId: postV1SocialAccountsByIdLiveBroadcasts
      x-operation-id-source: derived
  /v1/social-accounts/{id}/live-broadcasts/{liveId}/start:
    post:
      tags:
      - Live Video
      summary: Make a prepared Facebook Page broadcast live
      description: Makes a prepared Facebook broadcast visible now. Start your encoder before calling this endpoint. Facebook is authoritative for whether the broadcast becomes live.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: liveId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Facebook's current broadcast status
      operationId: postV1SocialAccountsByIdLiveBroadcastsByLiveIdStart
      x-operation-id-source: derived
  /v1/social-accounts/{id}/live-broadcasts/{liveId}:
    get:
      tags:
      - Live Video
      summary: Read a Facebook live broadcast
      description: Reads Facebook's authoritative broadcast status and final replay URL when available. Ingest credentials are never returned.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: liveId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
      operationId: getV1SocialAccountsByIdLiveBroadcastsByLiveId
      x-operation-id-source: derived
  /v1/social-accounts/{id}/live-broadcasts/{liveId}/end:
    post:
      tags:
      - Live Video
      summary: End a Facebook live broadcast
      description: Ends the Facebook broadcast. A successful response reflects Facebook's final status and replay URL where Facebook provides one.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: liveId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Ended
      operationId: postV1SocialAccountsByIdLiveBroadcastsByLiveIdEnd
      x-operation-id-source: derived