> ## 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 share



## OpenAPI

````yaml /openapi.yaml post /shares
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:
  /shares:
    post:
      tags:
        - Shares
      summary: Create a share
      operationId: createShare
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SharesResponse'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SharesResponse'
        '401':
          description: Not authenticated
components:
  schemas:
    SharesResponse:
      type: object
      properties:
        _id:
          type: string
          example: 507f1f77bcf86cd799439011
        from:
          type: object
          properties:
            _id:
              type: string
              example: 507f1f77bcf86cd799439011
            name:
              type: string
            emailNormal:
              type: string
              format: email
              example: user@example.com
            $links:
              type: object
              properties:
                self:
                  type: string
                  format: uri-reference
                  example: //example.com/path/to/object
        to:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                example: 507f1f77bcf86cd799439011
              name:
                type: string
              emailNormal:
                type: string
                format: email
                example: user@example.com
              $links:
                type: object
                properties:
                  self:
                    type: string
                    format: uri-reference
                    example: //example.com/path/to/object
        groups:
          description: Shape not inferred — the sampled response had no entries
        assets:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                example: 507f1f77bcf86cd799439011
              project:
                type: string
                example: 507f1f77bcf86cd799439011
              studio:
                type: string
                example: 507f1f77bcf86cd799439011
              name:
                type: string
              slug:
                type: string
              type:
                type: string
              length:
                type: integer
              thumbnail:
                type: string
                example: 507f1f77bcf86cd799439011
              notes:
                type: string
              created:
                type: integer
              mediaType:
                type: string
              creative:
                type: boolean
              $links:
                type: object
                properties:
                  self:
                    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
                  type:
                    type: string
                    format: uri-reference
                    example: //example.com/path/to/object
                  thumbnail:
                    type: string
                    format: uri-reference
                    example: //example.com/path/to/object
              $permissions:
                type: object
                properties:
                  canAutosub:
                    type: boolean
                  sources:
                    type: object
                    properties:
                      requests:
                        type: object
                        properties:
                          languages:
                            description: >-
                              Shape not inferred — the sampled response had no
                              entries
                          countries:
                            description: >-
                              Shape not inferred — the sampled response had no
                              entries
                      autosubs:
                        type: object
                        properties:
                          languages:
                            description: >-
                              Shape not inferred — the sampled response had no
                              entries
                          countries:
                            description: >-
                              Shape not inferred — the sampled response had no
                              entries
                  access:
                    type: array
                    items:
                      type: string
                  tags:
                    type: object
                    properties:
                      online:
                        type: boolean
                      broadcast:
                        type: boolean
                      dcp:
                        type: boolean
                      cmyk:
                        type: boolean
                      rgb:
                        type: boolean
                  ingest:
                    type: array
                    items:
                      type: string
              $feedback:
                type: object
                properties:
                  share:
                    description: Null in every sampled response — shape not inferred
                  vote:
                    description: Null in every sampled response — shape not inferred
                  summary:
                    description: Shape not inferred — the sampled response had no entries
        assetsCount:
          type: integer
        assetCategory:
          type: string
        projectNames:
          type: array
          items:
            type: string
        studios:
          type: array
          items:
            type: string
            example: 507f1f77bcf86cd799439011
        tags:
          type: array
          items:
            type: array
            items:
              type: string
        urls:
          type: object
          properties:
            playlist:
              type: string
              format: uri
              example: https://example.com/path/to/object
            invite:
              type: string
              format: uri
              example: https://example.com/path/to/object
          additionalProperties:
            type: string
            format: uri
            example: https://example.com/path/to/object
          description: Additional entries are keyed by record id.
        approved:
          type: boolean
        feedback:
          type: object
          properties:
            enabled:
              type: boolean
        created:
          type: integer
        questions:
          description: Shape not inferred — the sampled response had no entries
        $links:
          type: object
          properties:
            self:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
            from:
              type: string
              format: uri-reference
              example: //example.com/path/to/object
        permissions:
          type: array
          items:
            type: object
            properties:
              _id:
                type: string
                example: 507f1f77bcf86cd799439011
              sources:
                type: object
                properties:
                  download:
                    type: object
                    properties:
                      ov:
                        type: boolean
                      countries:
                        type: array
                        items:
                          type: string
                      languages:
                        type: array
                        items:
                          type: string
                  manageWorkRequests:
                    type: object
                    properties:
                      groups:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                  previews:
                    type: object
                    properties:
                      ov:
                        type: boolean
                      countries:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                      languages:
                        type: array
                        items:
                          type: string
                  requests:
                    type: object
                    properties:
                      ov:
                        type: boolean
                      countries:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                      languages:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                  social:
                    type: object
                    properties:
                      ov:
                        type: boolean
                      countries:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                      languages:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
                  adminWorkRequests:
                    type: object
                    properties:
                      groups:
                        description: >-
                          Shape not inferred — the sampled response had no
                          entries
              approved:
                type: boolean
              project:
                type: string
                example: 507f1f77bcf86cd799439011
              assets:
                type: array
                items:
                  type: string
                  example: 507f1f77bcf86cd799439011
              tags:
                type: array
                items:
                  oneOf:
                    - type: string
                    - type: array
                      items:
                        type: string
              types:
                description: Shape not inferred — the sampled response had no entries
              access:
                type: object
                properties:
                  sharing:
                    type: boolean
                  push:
                    type: boolean
                  download:
                    type: boolean
                  requests:
                    type: boolean
                  notes:
                    type: boolean
                  previews:
                    type:
                      - boolean
                      - 'null'
                  manageWorkRequsts:
                    type: boolean
                  projectAdminView:
                    type: boolean
                  projectAdminUpdate:
                    type: boolean
                  projectAdminEmbargos:
                    type: boolean
                  workRequestReport:
                    type: boolean
                  downloadReport:
                    type: boolean
                  exceptionReport:
                    type: boolean
                  groupSpendingReport:
                    type: boolean
                  adminWorkRequests:
                    type: boolean
                  shareVotingView:
                    type: boolean
                  manageWorkRequests:
                    type: boolean
                  ingest:
                    type: boolean
              user:
                type: string
                example: 507f1f77bcf86cd799439011
              share:
                type: string
                example: 507f1f77bcf86cd799439011
              $links:
                type: object
                properties:
                  self:
                    type: string
                    format: uri-reference
                    example: //example.com/path/to/object
        notes:
          type: string
  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.

````