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

# Preview

> The next times a repeat would fire, for a repeat that has not been saved yet



## OpenAPI

````yaml /renderflow/api-reference/openapi.json post /schedule/preview
openapi: 3.1.0
info:
  title: RenderFlow API
  version: 2.0.0
  description: Render farm management.
servers:
  - url: http://localhost:44442/api/v1
    description: The service on this machine. Answers without a credential
  - url: http://your-server:44442/api/v1
    description: A farm's server. Needs an API key
  - url: https://your-server:44445/api/v1
    description: A farm's server set up with TLS. Needs an API key
security:
  - bearerAuth: []
paths:
  /schedule/preview:
    post:
      tags:
        - Schedule
      summary: Preview
      description: >-
        The next times a repeat would fire, for a repeat that has not been saved
        yet
      operationId: previewSchedule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SchedulePreviewRequest'
      responses:
        '200':
          description: Upcoming occurrences
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchedulePreview'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '401':
          description: Missing or invalid credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: Not permitted for this credential
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '500':
          description: Unhandled server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    SchedulePreviewRequest:
      type: object
      properties:
        starts_at:
          type: string
          minLength: 1
          description: ISO 8601; defaults to now
        every:
          type:
            - string
            - 'null'
          maxLength: 32
          description: >-
            How often it repeats: `15m`, `1h`, `1d`, `2w`, `1 month`. Null fires
            once. With no `starts_at` this is dateless. The anchor is snapped to
            the unit, so `1h` means the top of every hour.
          example: 1d
        days:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/Weekday'
          description: >-
            Weekdays it may fall on, narrowing the cadence. Weekdays-only is
            ["mo","tu","we","th","fr"]
        monthday:
          type:
            - integer
            - 'null'
          minimum: -31
          maximum: 31
          description: >-
            Day of the month, or -1 for its last day. The one thing `starts_at`
            cannot say, since months differ in length
        nth:
          type:
            - integer
            - 'null'
          minimum: -53
          maximum: 53
          description: >-
            Which match to keep. With days ["fr"] and a monthly cadence, -1 is
            the last Friday of the month
        until:
          type:
            - string
            - 'null'
          description: >-
            Stop repeating after this date. Null repeats forever. Not `ends_at`:
            this is when the event stops recurring at all.
        count:
          type: integer
          minimum: 1
          maximum: 100
          default: 5
    SchedulePreview:
      type: object
      properties:
        occurrences:
          type: array
          items:
            type: string
          description: ISO 8601, earliest first
        rule:
          type:
            - string
            - 'null'
          description: The cadence as an iCalendar RRULE, for reference
      required:
        - occurrences
    ApiError:
      type: object
      properties:
        error:
          type: string
        tag:
          type: string
          description: The catalog entry this failure is, when it is one
        title:
          type: string
          description: The catalog entry's title
        detail:
          type: string
          description: What happened this time, and what to do
        issues:
          type: array
          items:
            type: object
            properties:
              path:
                type: array
                items:
                  anyOf:
                    - type: string
                    - type: number
              message:
                type: string
            required:
              - path
              - message
      required:
        - error
    Weekday:
      type: string
      enum:
        - mo
        - tu
        - we
        - th
        - fr
        - sa
        - su
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key from Settings, API Keys. A caller on this machine needs none.

````

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