Twilio

Twilio PlayerStreamers API

The PlayerStreamers API from Twilio — 3 operation(s) for playerstreamers.

Documentation GitHub OpenAPI

Operations 6

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/PlayerStreamers/{Sid} View a live stream player streamer · Fetch player streamer #

Ask an LLM

“What state is my live stream's PlayerStreamer in right now?”

“Can I look up a single PlayerStreamer by its SID?”

Tell an agent

Show PlayerStreamer {streamer}.

Check whether PlayerStreamer {streamer} has started or ended.

POST /v1/PlayerStreamers/{Sid} End a live stream PlayerStreamer · Update player streamer #

Ask an LLM

“How do I stop a PlayerStreamer that is still live?”

“Can I end a live stream by changing the PlayerStreamer's status?”

Tell an agent destructive · confirm first

Set PlayerStreamer {streamer} status to {status}.

End the live stream on PlayerStreamer {streamer} by setting status {status}.

POST /v1/PlayerStreamers Create a PlayerStreamer for a live stream · Create player streamer #

Ask an LLM

“How do I set up a new PlayerStreamer to broadcast a live stream?”

“Can I create an audio-only stream and cap how long it runs?”

Tell an agent

Create a new PlayerStreamer.

Create an audio-only PlayerStreamer with video set to {video} that ends after {max_duration} seconds.

GET /v1/PlayerStreamers List my PlayerStreamers · List player streamer #

Ask an LLM

“Which of my live streams are currently started?”

“Can I list PlayerStreamers that failed, oldest first?”

Tell an agent

List all my PlayerStreamers.

List PlayerStreamers with status {status} sorted {order}.

POST /v1/PlayerStreamers/{Sid}/PlaybackGrant Issue a playback grant so viewers can watch · Create player streamer playback grant #

Ask an LLM

“How do I give a viewer's player access to watch my live stream?”

“Can I restrict a playback grant to my own website's origin?”

Tell an agent

Create a playback grant for PlayerStreamer {streamer}.

Issue a playback grant for {streamer} valid for {ttl} seconds, only from {origin}.

GET /v1/PlayerStreamers/{Sid}/PlaybackGrant Get a PlayerStreamer playback grant · Fetch player streamer playback grant #

Ask an LLM

“Can I read back the playback grant already issued for a PlayerStreamer?”

“Is fetching an existing playback grant supported, or is that method disabled?”

Tell an agent

Fetch the existing playback grant for PlayerStreamer {streamer}.

Look up the playback grant already on {streamer}.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/twilio:twilio-playerstreamers-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Twilio - Media Player Streamers API
  description: This is the public Twilio REST API.
  termsOfService: https://www.twilio.com/legal/tos
  contact:
    name: Twilio Support
    url: https://support.twilio.com
    email: support@twilio.com
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.52.0
servers:
- url: https://media.twilio.com
tags:
- name: PlayerStreamers
paths:
  /v1/PlayerStreamers/{Sid}:
    servers:
    - url: https://media.twilio.com
    description: A PlayerStreamer resource provides the ability to send a livestream to a JavaScript, iOS, or Android Player SDK.
    x-twilio:
      defaultOutputProperties:
      - sid
      - status
      pathType: instance
      dependentProperties:
        timed_metadata:
          mapping:
            player_streamer_sid: sid
          resource_url: /v1None
        playback_grant:
          mapping:
            sid: sid
          resource_url: /v1None
        recording_playback_grant:
          mapping:
            sid: sid
          resource_url: /v1None
      mountName: player_streamer
    get:
      description: Returns a single PlayerStreamer resource identified by a SID.
      tags:
      - PlayerStreamers
      parameters:
      - name: Sid
        in: path
        description: The SID of the PlayerStreamer resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^VJ[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/media.v1.player_streamer'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchPlayerStreamer
      x-maturity:
      - GA
      summary: Fetch player streamer
      x-summary-source: derived
    post:
      description: Updates a PlayerStreamer resource identified by a SID.
      tags:
      - PlayerStreamers
      parameters:
      - name: Sid
        in: path
        description: The SID of the PlayerStreamer resource to update.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^VJ[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/media.v1.player_streamer'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: UpdatePlayerStreamer
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdatePlayerStreamerRequest'
      summary: Update player streamer
      x-summary-source: derived
  /v1/PlayerStreamers:
    servers:
    - url: https://media.twilio.com
    description: A PlayerStreamer resource provides the ability to send a livestream to a JavaScript, iOS, or Android Player SDK.
    x-twilio:
      defaultOutputProperties:
      - sid
      - status
      pathType: list
      dependentProperties:
        timed_metadata:
          mapping:
            player_streamer_sid: sid
          resource_url: /v1None
        playback_grant:
          mapping:
            sid: sid
          resource_url: /v1None
        recording_playback_grant:
          mapping:
            sid: sid
          resource_url: /v1None
      mountName: player_streamer
    post:
      description: ''
      tags:
      - PlayerStreamers
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/media.v1.player_streamer'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreatePlayerStreamer
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePlayerStreamerRequest'
      summary: Create player streamer
      x-summary-source: derived
    get:
      description: Returns a list of PlayerStreamers.
      tags:
      - PlayerStreamers
      parameters:
      - name: Order
        in: query
        description: 'The sort order of the list by `date_created`. Can be: `asc` (ascending) or `desc` (descending) with `desc` as the default.'
        schema:
          type: string
          $ref: '#/components/schemas/player_streamer_enum_order'
      - name: Status
        in: query
        description: Status to filter by, with possible values `created`, `started`, `ended`, or `failed`.
        schema:
          type: string
          $ref: '#/components/schemas/player_streamer_enum_status'
      - name: PageSize
        in: query
        description: How many resources to return in each list page. The default is 50, and the maximum is 1000.
        schema:
          type: integer
          minimum: 1
          maximum: 1000
      - name: Page
        in: query
        description: The page index. This value is simply for client state.
        schema:
          type: integer
          minimum: 0
      - name: PageToken
        in: query
        description: The page token. This is provided by the API.
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPlayerStreamerResponse'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: ListPlayerStreamer
      x-maturity:
      - GA
      summary: List player streamer
      x-summary-source: derived
  /v1/PlayerStreamers/{Sid}/PlaybackGrant:
    servers:
    - url: https://media.twilio.com
    description: A PlaybackGrant resource allows developers to generate a grant to initialize the Twilio Live Player SDK and connect to a livestream.
    x-twilio:
      defaultOutputProperties: []
      pathType: instance
      parent: /PlayerStreamers/{Sid}
    post:
      description: ''
      tags:
      - PlayerStreamers
      parameters:
      - name: Sid
        in: path
        description: The unique string generated to identify the PlayerStreamer resource associated with this PlaybackGrant
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^VJ[0-9a-fA-F]{32}$
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant'
          description: Created
      security:
      - accountSid_authToken: []
      operationId: CreatePlayerStreamerPlaybackGrant
      x-maturity:
      - GA
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/CreatePlayerStreamerPlaybackGrantRequest'
      summary: Create player streamer playback grant
      x-summary-source: derived
    get:
      description: '**This method is not enabled.** Returns a single PlaybackGrant resource identified by a SID.'
      tags:
      - PlayerStreamers
      parameters:
      - name: Sid
        in: path
        description: The SID of the PlayerStreamer resource to fetch.
        schema:
          type: string
          minLength: 34
          maxLength: 34
          pattern: ^VJ[0-9a-fA-F]{32}$
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/media.v1.player_streamer.player_streamer_playback_grant'
          description: OK
      security:
      - accountSid_authToken: []
      operationId: FetchPlayerStreamerPlaybackGrant
      x-maturity:
      - GA
      summary: Fetch player streamer playback grant
      x-summary-source: derived
components:
  schemas:
    CreatePlayerStreamerRequest:
      type: object
      properties:
        Video:
          type: boolean
          description: Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`.
        StatusCallback:
          type: string
          format: uri
          description: The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
        StatusCallbackMethod:
          type: string
          format: http-method
          enum:
          - HEAD
          - GET
          - POST
          - PATCH
          - PUT
          - DELETE
          description: The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
        MaxDuration:
          type: integer
          description: The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.
    UpdatePlayerStreamerRequest:
      type: object
      required:
      - Status
      properties:
        Status:
          type: string
          $ref: '#/components/schemas/player_streamer_enum_update_status'
          description: 'The status the PlayerStreamer should be transitioned to. Can be: `ended`.'
    player_streamer_enum_status:
      type: string
      enum:
      - created
      - started
      - ended
      - failed
    player_streamer_enum_update_status:
      type: string
      enum:
      - ended
    player_streamer_enum_ended_reason:
      type: string
      enum:
      - ended-via-api
      - max-duration-exceeded
      - stream-disconnected-by-source
      - unexpected-failure
    media.v1.player_streamer:
      type: object
      properties:
        account_sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PlayerStreamer resource.
        date_created:
          type:
          - string
          - 'null'
          format: date-time
          description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        date_updated:
          type:
          - string
          - 'null'
          format: date-time
          description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        video:
          type:
          - boolean
          - 'null'
          description: Specifies whether the PlayerStreamer is configured to stream video. Defaults to `true`.
        links:
          type:
          - object
          - 'null'
          format: uri-map
          description: The URLs of related resources.
        sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^VJ[0-9a-fA-F]{32}$
          description: The unique string generated to identify the PlayerStreamer resource.
        status:
          type:
          - string
          - 'null'
          $ref: '#/components/schemas/player_streamer_enum_status'
          description: 'The status of the PlayerStreamer. Can be: `created`, `started`, `ended`, or `failed`. See [status](/docs/live/api/playerstreamers#status) for more information.'
        url:
          type:
          - string
          - 'null'
          format: uri
          description: The absolute URL of the resource.
        status_callback:
          type:
          - string
          - 'null'
          format: uri
          description: The URL to which Twilio will send asynchronous webhook requests for every PlayerStreamer event. See [Status Callbacks](/docs/live/api/status-callbacks) for more details.
        status_callback_method:
          type:
          - string
          - 'null'
          format: http-method
          enum:
          - HEAD
          - GET
          - POST
          - PATCH
          - PUT
          - DELETE
          description: The HTTP method Twilio should use to call the `status_callback` URL. Can be `POST` or `GET` and the default is `POST`.
        ended_reason:
          type:
          - string
          - 'null'
          $ref: '#/components/schemas/player_streamer_enum_ended_reason'
          description: The reason why a PlayerStreamer ended. When a PlayerStreamer is in progress, will be `null`. When a PlayerStreamer is completed, can be `ended-via-api`, `max-duration-exceeded`, `stream-disconnected-by-source` or `unexpected-failure`. See [ended reasons](/docs/live/api/playerstreamers#ended-reason) for more details.
        max_duration:
          type:
          - integer
          - 'null'
          description: The maximum time, in seconds, that the PlayerStreamer is active (`created` or `started`) before automatically ends. The default value is 300 seconds, and the maximum value is 90000 seconds. Once this maximum duration is reached, Twilio will end the PlayerStreamer, regardless of whether media is still streaming.
    CreatePlayerStreamerPlaybackGrantRequest:
      type: object
      properties:
        Ttl:
          type: integer
          description: The time to live of the PlaybackGrant. Default value is 15 seconds. Maximum value is 60 seconds.
        AccessControlAllowOrigin:
          type: string
          description: The full origin URL where the livestream can be streamed. If this is not provided, it can be streamed from any domain.
    player_streamer_enum_order:
      type: string
      enum:
      - asc
      - desc
    ListPlayerStreamerResponse:
      type: object
      properties:
        player_streamers:
          type: array
          items:
            $ref: '#/components/schemas/media.v1.player_streamer'
        meta:
          type: object
          properties:
            first_page_url:
              type: string
              format: uri
            next_page_url:
              type:
              - string
              - 'null'
              format: uri
            page:
              type: integer
            page_size:
              type: integer
            previous_page_url:
              type:
              - string
              - 'null'
              format: uri
            url:
              type: string
              format: uri
            key:
              type: string
    media.v1.player_streamer.player_streamer_playback_grant:
      type: object
      properties:
        sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^VJ[0-9a-fA-F]{32}$
          description: The unique string generated to identify the PlayerStreamer resource that this PlaybackGrant authorizes views for.
        url:
          type:
          - string
          - 'null'
          format: uri
          description: The absolute URL of the resource.
        account_sid:
          type:
          - string
          - 'null'
          minLength: 34
          maxLength: 34
          pattern: ^AC[0-9a-fA-F]{32}$
          description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this resource.
        date_created:
          type:
          - string
          - 'null'
          format: date-time
          description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
        grant:
          description: The grant that authorizes the player sdk to connect to the livestream
  securitySchemes:
    accountSid_authToken:
      type: http
      scheme: basic
x-maturity:
- name: GA
  description: This product is Generally Available.
- name: Preview
  description: PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact https://www.twilio.com/help/contact.

Twilio PlayerStreamers API

Operations 6

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification