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

# POST /playlists

> Workspace-owned resources only. No unsupported query parameters on details or writes. Required permissions: playlists.create. Use Postman or your backend. Keep your API key private; do not enter it in this public documentation page.

Required permissions: `playlists.create`.

Send an `Idempotency-Key` for this change. It is an operation ID, not an API key. [Generate a UUID](https://docs.layarva.com/developers/platform-request-keys.md) and reuse it when retrying the same request.

> [!NOTE]
>
> Use your Platform API key in Postman or your backend. Keep it private; do not enter it in this public page. Your workspace permissions and plan limits apply.

See the [quickstart](https://docs.layarva.com/developers/platform-quickstart.md) for request examples. Required fields and responses are listed below.


## OpenAPI

````yaml api/platform-workspace.openapi.json POST /playlists
openapi: 3.1.0
info:
  title: Layarva Platform / Workspace API
  version: 1.1.0
  description: >-
    Manage Library, Playlists, Channels, Locations, Edges, Screens and
    Schedules. Use a Platform key, not a Widget key. See
    https://docs.layarva.com/developers/platform-quickstart. Upload supported
    files, export eligible offline packages and receive signed Platform
    webhooks. Permissions, plan limits and publishing rules apply. If a request
    returns 503, stop that workflow and contact support with its requestId.
servers:
  - url: https://api.layarva.com/api/platform/v1/workspaces/{workspaceId}
    variables:
      workspaceId:
        default: workspace_example
security:
  - PlatformBearer: []
paths:
  /playlists:
    post:
      tags:
        - playlists
      summary: POST /playlists
      description: >-
        Workspace-owned resources only. No unsupported query parameters on
        details or writes. Required permissions: playlists.create. Use Postman
        or your backend. Keep your API key private; do not enter it in this
        public documentation page.
      operationId: post__playlists
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            pattern: ^[A-Za-z0-9._:-]{1,128}$
          description: >-
            An operation ID, not your API key. Generate a UUID for each new
            change and reuse it when retrying the same request. See
            https://docs.layarva.com/developers/platform-request-keys for
            Postman, PowerShell and Node.js examples. Upload instructions are
            refreshed when requested again.
      requestBody:
        required: true
        description: >-
          Send application/json using the fields below. JSON requests must be no
          larger than 64 KiB.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaylistCreate'
      responses:
        '201':
          description: Safe live-authorized result
          headers:
            X-Request-Id:
              schema:
                type: string
            Cache-Control:
              schema:
                const: private, no-store
            X-RateLimit-Limit:
              schema:
                type: string
            X-RateLimit-Remaining:
              schema:
                type: string
            Idempotency-Replayed:
              schema:
                enum:
                  - 'true'
                  - 'false'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/PlaylistCommand'
                required:
                  - data
                additionalProperties: false
        default:
          description: >-
            Error with code, message and requestId. Follow Retry-After when
            present. Contact support with the requestId if the problem
            continues.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          headers:
            X-Request-Id:
              schema:
                type: string
            Retry-After:
              schema:
                type: string
components:
  schemas:
    PlaylistCreate:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 120
        description:
          default: ''
          type: string
          maxLength: 500
        items:
          default: []
          maxItems: 100
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                pattern: ^[A-Za-z0-9_-]{1,100}$
              sourceType:
                type: string
                enum:
                  - design
                  - image
                  - video
                  - audio
                  - lottie
              sourceId:
                type: string
                pattern: ^(?:[A-Za-z0-9_-]{1,100}|preset:[A-Za-z0-9_-]{1,80})$
              durationSeconds:
                default: 10
                type: integer
                minimum: 1
                maximum: 86400
              enabled:
                default: true
                type: boolean
              transition:
                type: object
                properties:
                  type:
                    type: string
                    enum:
                      - NONE
                      - FADE
                      - CROSSFADE
                      - SLIDE
                      - PUSH
                      - WIPE
                      - ZOOM_FADE
                      - DIP_TO_COLOR
                  durationMs:
                    type: integer
                    minimum: 0
                    maximum: 5000
                  direction:
                    type: string
                    enum:
                      - LEFT
                      - RIGHT
                      - UP
                      - DOWN
                  color:
                    type: string
                    pattern: ^#[0-9a-f]{6}$
                required:
                  - type
                  - durationMs
                additionalProperties: false
            required:
              - sourceType
              - sourceId
            additionalProperties: false
        defaultTransition:
          type: object
          properties:
            type:
              type: string
              enum:
                - NONE
                - FADE
                - CROSSFADE
                - SLIDE
                - PUSH
                - WIPE
                - ZOOM_FADE
                - DIP_TO_COLOR
            durationMs:
              type: integer
              minimum: 0
              maximum: 5000
            direction:
              type: string
              enum:
                - LEFT
                - RIGHT
                - UP
                - DOWN
            color:
              type: string
              pattern: ^#[0-9a-f]{6}$
          required:
            - type
            - durationMs
          additionalProperties: false
      required:
        - name
      additionalProperties: false
      description: >-
        Source references resolve from owned live assets/designs, not URLs or
        caller metadata. Up to 100 items; durations may be increased to
        authoritative media minimum. Source URL/manifest/Widget secrets not
        accepted. NONE transition requires duration 0; other transitions
        100–5000ms; SLIDE/PUSH/WIPE require direction; DIP_TO_COLOR requires
        color. PATCH needs expectedDraftRevision and at least one editable
        field.
    PlaylistCommand:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        latestReadyVersionId:
          anyOf:
            - type: string
            - type: 'null'
        draftRevision:
          type: number
        itemCount:
          type: number
      required:
        - id
        - name
        - latestReadyVersionId
        - draftRevision
        - itemCount
      additionalProperties: false
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            requestId:
              type: string
          required:
            - code
            - message
            - requestId
          additionalProperties: false
      required:
        - error
      additionalProperties: false
  securitySchemes:
    PlatformBearer:
      type: http
      scheme: bearer
      bearerFormat: lv_platform_<43 base64url characters>
      description: >-
        Platform API key for one workspace. Create it in Settings with an expiry
        date or Never expire. Keep it private; use it from Postman or your
        backend, not browser code. Widget keys are not accepted.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.