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

# Preview Schedule

> A preview running the scheduler's own occurrence function, so the form never promises times the
tick would not fire. The agent switch gates agent schedules only: a workflow schedule is previewed on
a deployment that has it off.

API key permission: Agents (Admin also opens it).



## OpenAPI

````yaml /api-reference/openapi.json post /schedules/preview
openapi: 3.1.0
info:
  title: Neural Factory API
  version: 0.1.0
  description: >-
    The endpoints a program can call with an API key. Exchange the key's secret
    for a token at POST /apikeys/token and send it as a Bearer token.
servers:
  - url: https://api.neuralfactory.ai
    description: SaaS
  - url: https://{apiHost}
    description: 'Enterprise: the API address of your own deployment'
    variables:
      apiHost:
        default: api.example.com
        description: Your deployment's API host
security:
  - bearerAuth: []
tags:
  - name: API keys
  - name: Chat
  - name: Runs
  - name: Agents
  - name: Workflows
  - name: Schedules
  - name: Knowledge bases
  - name: Documents
  - name: Search
  - name: Skills
  - name: Toolkits
  - name: Files
  - name: Interactions
  - name: Usage and billing
  - name: Catalogue
  - name: Browser
  - name: Users
  - name: Groups
  - name: Builds
paths:
  /schedules/preview:
    post:
      tags:
        - Schedules
      summary: Preview Schedule
      description: >-
        A preview running the scheduler's own occurrence function, so the form
        never promises times the

        tick would not fire. The agent switch gates agent schedules only: a
        workflow schedule is previewed on

        a deployment that has it off.


        API key permission: Agents (Admin also opens it).
      operationId: preview_schedule_schedules_preview_post
      parameters:
        - name: env
          in: query
          required: false
          schema:
            title: Env
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PreviewRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PreviewRequest:
      properties:
        expression:
          type: string
          title: Expression
        timezone:
          type: string
          title: Timezone
        count:
          type: integer
          maximum: 10
          minimum: 1
          title: Count
          default: 5
        target_kind:
          type: string
          enum:
            - agent
            - workflow
          title: Target Kind
          default: agent
      type: object
      required:
        - expression
        - timezone
      title: PreviewRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        The access_token returned by POST /apikeys/token for an API key's
        secret.

````

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