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

# Preview proposal

> Writes a cover letter for one real job with the template, as the template editor's preview does, and waits for it. That can take a few minutes. draft takes template fields to try without saving, in the PATCH /proposal-templates/{id} shape. Spends one preview from the plan's preview quota



## OpenAPI

````yaml post /proposal-templates/{id}/preview
openapi: 3.0.4
info:
  title: Vollna API
  description: API for managing Upwork profiles, proposals, results, and filters
  version: 1.0.0
servers:
  - url: https://api.vollna.com/v1
security: []
tags:
  - name: Profiles
    description: Manage Upwork profiles
  - name: Proposals
    description: Access and manage Upwork proposals
  - name: Results
    description: View monitoring results and projects
  - name: Filters
    description: Manage monitoring filters
  - name: Auto Bidding
    description: Manage auto bidding jobs and setups
  - name: Account
    description: The token team's account, plan and meters
  - name: Invitations
    description: Upwork invitations
  - name: Projects
    description: Upwork jobs and their competition
  - name: AI Qualifier
    description: A filter's AI qualifier and its verdicts
  - name: Market Insights
    description: Upwork market analytics and saved searches
  - name: Proposal Templates
    description: Proposal templates and their results
paths:
  /proposal-templates/{id}/preview:
    post:
      tags:
        - Proposal Templates
      summary: Preview proposal
      description: >-
        Writes a cover letter for one real job with the template, as the
        template editor's preview does, and waits for it. That can take a few
        minutes. draft takes template fields to try without saving, in the PATCH
        /proposal-templates/{id} shape. Spends one preview from the plan's
        preview quota
      parameters:
        - name: id
          in: path
          required: true
          description: Template ID
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                job:
                  type: string
                  description: A Vollna project id or an Upwork job URL
                draft:
                  type: object
                  description: Template fields to try, as in PATCH /proposal-templates/{id}
              required:
                - job
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      status:
                        type: string
                        example: ok
                      letter:
                        type: string
                      variant:
                        type: string
                        nullable: true
                      answers:
                        type: array
                        description: Answers to the job's screening questions
                        items:
                          type: object
                      template:
                        type: object
                        properties:
                          id:
                            type: integer
                          name:
                            type: string
                          draft:
                            type: boolean
                            description: A draft was tried
                      job:
                        type: object
                        properties:
                          projectId:
                            type: integer
                          title:
                            type: string
                            nullable: true
                          url:
                            type: string
                            nullable: true
                      quota:
                        type: object
                        properties:
                          usedToday:
                            type: integer
                          dailyLimit:
                            type: integer
                            nullable: true
                          usedMonth:
                            type: integer
                          monthlyLimit:
                            type: integer
                            nullable: true
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '402':
          $ref: '#/components/responses/PaymentRequired'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: The template or the job was not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '429':
          description: The preview quota is used up, or the rate limit is reached
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ServiceError'
        '502':
          description: The AI writer returned no letter. Try again in a minute
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: preview_failed
                  status:
                    type: string
                    example: failed
                  message:
                    type: string
                  template:
                    type: object
                  job:
                    type: object
                  quota:
                    type: object
      security:
        - apiToken: []
components:
  responses:
    BadRequest:
      description: >-
        Invalid request. message says what to send instead; fields names each
        invalid field
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
    Unauthorized:
      description: Missing or unknown API token
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    PaymentRequired:
      description: The team's subscription is not active
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: >-
        The plan has no API access, or the token team may not do this. message
        says why
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServiceError'
  schemas:
    ServiceError:
      type: object
      properties:
        error:
          type: string
          description: Short error title
          example: Validation failed
        message:
          type: string
          description: What went wrong and what to send instead, written for the user
        fields:
          type: object
          description: >-
            Per-field messages keyed by dot path, when several fields fail at
            once
          additionalProperties:
            type: string
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    apiToken:
      type: apiKey
      name: X-API-TOKEN
      in: header
      description: API token for authentication

````

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