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

# Create a preview



## OpenAPI

````yaml /openapi.yaml post /previews
openapi: 3.1.0
info:
  title: Pixwel Platform
  description: >-
    The Pixwel Platform REST API. Authenticate with HTTP Basic (email +
    password) or a personal access token (`Authorization: Bearer pat_…`).
    Responses are decorated by proxy middleware (Fields, Links, Permissions,
    etc.). Use `?fields=` to request specific fields.
  version: '2.8'
  contact:
    email: jeff@pixwel.com
  license:
    name: UNLICENSED
    identifier: LicenseRef-Pixwel-Proprietary
servers:
  - url: https://api-staging.pixwel.com/api
    description: Staging
  - url: https://app.pixwel.com/api
    description: Production
security:
  - BasicAuth: []
  - BearerAuth: []
paths:
  /previews:
    post:
      tags:
        - Previews
      summary: Create a preview
      operationId: createPreview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewsResponse'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewsResponse'
        '401':
          description: Not authenticated
components:
  schemas:
    PreviewsResponse:
      type: object
      properties:
        _id:
          type: string
          example: 507f1f77bcf86cd799439011
        asset:
          type: string
          example: 507f1f77bcf86cd799439011
        project:
          type: string
          example: 507f1f77bcf86cd799439011
        studio:
          type: string
          example: 507f1f77bcf86cd799439011
        revision:
          type: string
        label:
          type: string
        created:
          type: integer
        $links:
          type: object
          properties:
            self:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
            asset:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
            project:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
            studio:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
        path:
          type: string
          format: uri
          example: https://example.com/path/to/object
        language:
          type: string
        type:
          type: string
        embargo:
          type: object
          properties:
            start:
              description: Null in every sampled response — shape not inferred
            end:
              type: integer
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic
      description: >-
        Email address and password. A personal access token (`pat_…`) or session
        token (`token-…`) may also be sent in the password field, with any
        non-empty value as the username — a blank username short-circuits to a
        401 before the token is read.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: pat_<64 hex characters>
      description: >-
        A personal access token: `Authorization: Bearer pat_…`. Create one under
        Preferences → API Tokens, or with `POST /personal-access-tokens`. The
        token acts as its owner, with their full permissions.

````