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

# Preview one skill, a literal prompt and optional Event template

> Requires the skills:read scope.

Accepts a scoped bearer token, vendor-verified run identity, or interactive owner session.



## OpenAPI

````yaml /openapi.yaml post /api/v1/triggers/preview
openapi: 3.1.0
info:
  title: Factorize API
  version: 1.0.0
  description: >-
    Versioned Factorize REST API. See the hosted docs for examples and OAuth
    discovery.
  x-dashboard-auth: >-
    Access-token and authorized-client management and trace replay operations
    require an interactive owner session; all other operations accept a suitably
    scoped bearer token or owner session.
servers:
  - url: https://app.factorize.sh
security:
  - bearerAuth: []
paths:
  /api/v1/triggers/preview:
    post:
      tags:
        - triggers
      summary: Preview one skill, a literal prompt and optional Event template
      description: >-
        Requires the skills:read scope.


        Accepts a scoped bearer token, vendor-verified run identity, or
        interactive owner session.
      operationId: post_api_v1_triggers_preview
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                skillId:
                  anyOf:
                    - type: string
                      format: uuid
                      pattern: >-
                        ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                    - type: 'null'
                prompt:
                  default: ''
                  type: string
                  maxLength: 50000
                eventTemplate:
                  type: string
                  maxLength: 50000
                eventData:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                eventSlug:
                  type: string
                  maxLength: 64
                eventKind:
                  default: manual
                  type: string
                  enum:
                    - manual
                    - schedule
                    - webhook
                    - triggerLifecycle
                    - triggerIdle
                instructions:
                  default: ''
                  type: string
                  maxLength: 50000
                runNameTemplate:
                  type: string
                  maxLength: 500
              additionalProperties: false
      responses:
        '200':
          description: Prompt preview
          content:
            application/json:
              schema:
                type: object
                properties:
                  prompt:
                    type: string
                  eventText:
                    type: string
                  skill:
                    anyOf:
                      - type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            pattern: >-
                              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                          key:
                            type: string
                          revision:
                            type: integer
                            exclusiveMinimum: 0
                            maximum: 9007199254740991
                        required:
                          - id
                          - key
                          - revision
                        additionalProperties: false
                      - type: 'null'
                  runName:
                    type: string
                required:
                  - prompt
                  - eventText
                  - skill
                  - runName
                additionalProperties: false
        '400':
          $ref: '#/components/responses/Error400'
        '401':
          $ref: '#/components/responses/Error401'
        '403':
          $ref: '#/components/responses/Error403'
        '404':
          $ref: '#/components/responses/Error404'
        '409':
          $ref: '#/components/responses/Error409'
        '415':
          $ref: '#/components/responses/Error415'
        '429':
          $ref: '#/components/responses/Error429'
        '500':
          $ref: '#/components/responses/Error500'
        '503':
          $ref: '#/components/responses/Error503'
      security:
        - bearerAuth: []
        - vendorRunIdentity: []
          runIdentityHeader: []
        - cookieAuth: []
components:
  responses:
    Error400:
      description: Invalid request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error401:
      description: Invalid or revoked credentials
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error403:
      description: Missing scope or required owner session
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error404:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error409:
      description: Operation conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error415:
      description: Unsupported media type; use application/json
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error429:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error500:
      description: Internal error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Error503:
      description: Service unavailable
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
            message:
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: OAuth2
    vendorRunIdentity:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Fresh vendor-signed exe.dev WIF or Fly Machine OIDC token matching the
        provisioned active run. Must be combined with X-Factorize-Run-Id; a
        vendor token alone grants no access.
    runIdentityHeader:
      type: apiKey
      in: header
      name: X-Factorize-Run-Id
      description: >-
        Provisioned run UUID. Used only to locate the immutable vendor/VM
        binding; this header is not a credential. Scopes and tenant come from
        the server-side run snapshot.
    cookieAuth:
      type: apiKey
      in: cookie
      name: factorize_session

````

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