zvid-io Library API

openapi: 3.2.0
info:
  title: Zvid Io Library API
  version: 1.1.0
  contact:
    name: Zvid Support
    url: https://zvid.io/contact
  description: 'Operations tagged Library across 2 of this provider''s published API definitions: openapi.yaml, zvid-io-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.zvid.io
  description: Production server
security:
- ApiKeyAuth: []
tags:
- name: Library
  description: Designed examples and reusable creative assets
paths:
  /api/library/{kind}:
    get:
      tags:
      - Library
      operationId: listLibraryItems
      summary: List creative library items
      description: Public curated assets. Supply limit for paginated search; offset requires limit. q filters the paginated request. Without pagination, the whole current list is returned. Premium metadata omits contentUrl.
      parameters:
      - name: kind
        in: path
        required: true
        schema:
          enum:
          - examples
          - design-templates
          - canvas-presets
          - shapes
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          maximum: 100
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          maximum: 100000
          default: 0
      - name: q
        in: query
        required: false
        schema:
          type: string
          maxLength: 80
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryList'
        '400':
          description: Invalid input or semantic validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not found for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/library/{kind}/{slug}:
    get:
      tags:
      - Library
      operationId: getLibraryItem
      summary: Get creative library metadata
      description: Read metadata for an active library item. Fetch its content separately.
      parameters:
      - name: kind
        in: path
        required: true
        schema:
          enum:
          - examples
          - design-templates
          - canvas-presets
          - shapes
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LibraryItem'
        '400':
          description: Invalid input or semantic validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '404':
          description: Not found for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security: []
    servers:
    - url: https://api.zvid.io
      description: Production server
  /api/library/{kind}/{slug}/content:
    get:
      tags:
      - Library
      operationId: getLibraryContent
      summary: Get creative library content
      description: Returns a 302 redirect to the versioned CDN JSON. Free items are public. Premium items require authentication and a paid plan. Follow the redirect and adapt the returned content; do not guess CDN paths.
      parameters:
      - name: kind
        in: path
        required: true
        schema:
          enum:
          - examples
          - design-templates
          - canvas-presets
          - shapes
      - name: slug
        in: path
        required: true
        schema:
          type: string
      responses:
        '302':
          description: Fetch content from the Location URL
          headers:
            Location:
              schema:
                type: string
                format: uri
        '400':
          description: Invalid input or semantic validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: A paid plan is required for this item
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found for this account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: Content unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - {}
      - ApiKeyAuth: []
      - BearerAuth: []
    servers:
    - url: https://api.zvid.io
      description: Production server
components:
  schemas:
    ValidationError:
      type: object
      properties:
        error:
          type: string
          example: Validation failed
        message:
          type: string
          example: Please check your input and try again
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
                example: name
              message:
                type: string
                example: Name is required
            required:
            - field
            - message
            additionalProperties: false
        planLimits:
          type: object
          description: Present on render validation errors; contains the authenticated user's current render limits.
          additionalProperties: true
      required:
      - error
      additionalProperties: true
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error type
        message:
          type: string
          description: Human-readable error message
      required:
      - error
      additionalProperties: true
    LibraryItem:
      type: object
      properties:
        kind:
          type: string
        slug:
          type: string
        title:
          type: string
        description:
          type: string
        meta:
          anyOf:
          - type: object
            additionalProperties: true
          - type: 'null'
        version:
          type: integer
        sortOrder:
          type: integer
        status:
          type: string
        contentUrl:
          type: string
          description: Omitted for premium items; use the content endpoint.
        contentHash:
          type: string
        createdAt:
          type: string
        updatedAt:
          type: string
      required:
      - kind
      - slug
      - title
      additionalProperties: true
    AuthenticationError:
      type: object
      properties:
        error:
          type: string
          description: Error type
          example: API key required
        message:
          type: string
          description: Human-readable error message
          example: Please provide an API key in the X-API-Key header or Authorization header
      required:
      - error
      additionalProperties: false
    LibraryList:
      type: object
      properties:
        kind:
          type: string
        items:
          type: array
          items:
            $ref: '#/components/schemas/LibraryItem'
        total:
          type: integer
        limit:
          type: integer
        offset:
          type: integer
        hasMore:
          type: boolean
      required:
      - kind
      - items
      additionalProperties: true
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key for authentication. Create one in your dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Dashboard JWT in Authorization: Bearer <token>, only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a separate connection at https://mcp.zvid.io/mcp.'
x-refined-from:
- openapi.yaml
- zvid-io-openapi.yaml