> ## 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 /screens/{id}/offline-exports

> If this request returns 503, stop the workflow and retry later when instructed, or contact support with its requestId. Request a signed package for an eligible OFFLINE Screen's immutable published content. Save the export ID, check its status until READY, then request download instructions. An accepted request does not download the package. Required permissions: screens.offline-export. Use Postman or your backend. Keep your API key private; do not enter it in this public documentation page.

> [!NOTE]
>
> If this request returns `503`, stop the workflow and retry later when instructed, or contact support with the response `requestId`. See the [step-by-step offline export guide](https://docs.layarva.com/developers/platform-offline.md).

Requests a package from the Screen's eligible published content. Save the returned export `id`, check its status until `READY`, then request a temporary download URL. This request does not download the file itself.

Required permissions: `screens.offline-export`.

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 /screens/{id}/offline-exports
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:
  /screens/{id}/offline-exports:
    post:
      tags:
        - screens
      summary: POST /screens/{id}/offline-exports
      description: >-
        If this request returns 503, stop the workflow and retry later when
        instructed, or contact support with its requestId. Request a signed
        package for an eligible OFFLINE Screen's immutable published content.
        Save the export ID, check its status until READY, then request download
        instructions. An accepted request does not download the package.
        Required permissions: screens.offline-export. Use Postman or your
        backend. Keep your API key private; do not enter it in this public
        documentation page.
      operationId: post__screens_id_offline_exports
      parameters:
        - name: id
          in: path
          required: true
          schema:
            $ref: '#/components/schemas/Id'
        - 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/Empty'
      responses:
        '202':
          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/OfflineExport'
                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:
    Id:
      $schema: https://json-schema.org/draft/2020-12/schema
      type: string
      pattern: ^[A-Za-z0-9_-]{1,100}$
    Empty:
      type: object
      properties: {}
      additionalProperties: false
    OfflineExport:
      type: object
      properties:
        id:
          type: string
        screenId:
          type: string
        channelId:
          type: string
        publicationId:
          type: string
        status:
          enum:
            - REQUESTED
            - BUILDING
            - READY
            - FAILED
            - CANCELLED
            - CLEANUP_PENDING
            - CLEANED
        createdAt:
          type: string
          format: date-time
        expiresAt:
          type: string
          format: date-time
        leaseValidUntil:
          type: string
          format: date-time
        sizeBytes:
          anyOf:
            - type: number
            - type: 'null'
        checksumSha256:
          anyOf:
            - type: string
            - type: 'null'
        failureCode:
          anyOf:
            - type: string
            - type: 'null'
      required:
        - id
        - screenId
        - channelId
        - publicationId
        - status
        - createdAt
        - expiresAt
        - leaseValidUntil
        - sizeBytes
        - checksumSha256
        - failureCode
      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.