@apifreaks/openapi-specs 0.1.2 → 0.3.0

package/dist/specs/other/astronomy-data.yaml

@@ -287,6 +287,9 @@ paths:
                       moon_parallactic_angle: 53.576490644915204
                       moon_illumination_percentage: '77.00'
                       moon_angle: 122.67689249117335
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request – Invalid parameters provided
           content:
@@ -306,6 +309,9 @@ paths:
                   summary: Invalid date format
                   value:
                     message: You must provide date in the 'yyyy-MM-dd' format
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found
           content:
@@ -317,6 +323,9 @@ paths:
                   summary: Location not found
                   value:
                     message: We couldn't find the location (ZZZNOTEXIST). Try a city or state level location address only.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -627,6 +636,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/bulk-pdf-generator.yaml

@@ -0,0 +1,231 @@
+openapi: 3.1.1
+info:
+  title: PDF Generator API - Bulk PDF Generation from CSV
+  version: 1.0.0
+  description: Generate one PDF per row from an uploaded CSV file against a template you designed in the APIFreaks PDF Template Builder. Each row is processed independently, and the response returns an array of results, each with its own pdf_url. Authentication is done with your APIFreaks API key passed in the X-apikey header.
+  contact:
+    name: APIFreaks Support
+    url: https://apifreaks.com/contact
+    email: support@apifreaks.com
+servers:
+  - url: https://api.apifreaks.com/v1.0
+    description: PDF Generator API Server
+paths:
+  /pdf/template/generate/bulk:
+    post:
+      tags:
+        - PDF Template APIs
+      summary: Generate PDFs in bulk from a CSV
+      description: Upload a CSV file where each row is one record. The API generates one PDF per row and returns an array of results, each with its own pdf_url. Rows are processed independently, so a failure in one row does not block the rest of the batch. The response gives a row-by-row breakdown of which PDFs succeeded and which failed.
+      parameters:
+        - name: template_id
+          in: query
+          required: true
+          schema:
+            type: string
+          description: The template to render, from the APIFreaks PDF Template Builder. Copy it from your dashboard when you save the template.
+        - name: version
+          in: query
+          required: false
+          schema:
+            type: string
+            pattern: ^v
+          description: Template version to render, e.g. v2. Must start with v. Omit this parameter entirely to use the latest version; the literal value 'latest' is not accepted by the API.
+      requestBody:
+        description: Multipart form-data body carrying the CSV file to render. Each row in the CSV is one record and produces one PDF.
+        required: true
+        content:
+          multipart/form-data:
+            schema:
+              $ref: '#/components/schemas/CsvUploadRequest'
+      responses:
+        '200':
+          description: PDFs generated successfully. The response is an array of results, one entry per CSV row, each with its own pdf_url.
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/TemplateGenerationResponse'
+              examples:
+                success:
+                  summary: Generated PDFs for two rows
+                  value:
+                    - template_id: 73691bce-1c58-4370-acc6-64b2dd14f81c
+                      pdf_url: https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/pdf_templates/73691bce-1c58-4370-acc6-64b2dd14f81c/Candidate%20Resume_20260810141245054106_1.pdf
+                      created_at: '2026-08-10T14:12:47.887Z'
+                      expiration_time: '2026-11-10T14:12:47.887Z'
+                    - template_id: 73691bce-1c58-4370-acc6-64b2dd14f81c
+                      pdf_url: https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/pdf_templates/73691bce-1c58-4370-acc6-64b2dd14f81c/Candidate%20Resume_20260810141245054154_2.pdf
+                      created_at: '2026-08-10T14:12:47.940Z'
+                      expiration_time: '2026-11-10T14:12:47.940Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '400':
+          description: Bad Request — Missing parameters, a file that is not a CSV, or data larger than 10 MB.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                CsvFileRequired:
+                  summary: Uploaded file is not a CSV
+                  value:
+                    timestamp: '2026-08-10T14:13:14.497Z'
+                    path: /v1.0/generate-pdf/bulk
+                    status: 400
+                    error: CSV File Required
+                    message: Only CSV files are supported. Please upload a valid CSV file.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '401':
+          description: Unauthorized — The API key is missing or invalid.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+              examples:
+                InvalidApiKey:
+                  summary: Provided API key is invalid
+                  value:
+                    error: API Access Exception
+                    message: 'Provided API key is invalid. [For Technical Support: support@apifreaks.com]'
+                    path: /v1.0/pdf/template/generate/bulk
+                    status: 401
+                    timestamp: '2026-08-10T14:13:14.996Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '403':
+          description: Forbidden — The account does not have access to this template.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '404':
+          description: Not Found — No template matches the template_id, or the requested version does not exist.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '415':
+          description: Unsupported Media Type — The request Content-Type is not supported for this endpoint.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '422':
+          description: Unprocessable Entity — The request contains invalid or missing data.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '500':
+          description: Internal Server Error — An unexpected error occurred, or the PDF could not be generated.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+        '504':
+          description: Gateway Timeout — The request went past the 100 second processing limit.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
+      operationId: generatePdfsFromCsv
+components:
+  securitySchemes:
+    ApiKeyAuthHeader:
+      type: apiKey
+      in: header
+      name: X-apikey
+      description: Pass your API key via the X-apikey request header.
+    ApiKeyAuthQuery:
+      type: apiKey
+      in: query
+      name: apiKey
+      description: Pass your API key via the apiKey query parameter.
+  schemas:
+    TemplateGenerationResponse:
+      type: object
+      description: Result of a PDF generation request, containing the hosted URL of the generated PDF.
+      required:
+        - template_id
+        - pdf_url
+        - created_at
+        - expiration_time
+      properties:
+        template_id:
+          type: string
+          description: The template that was rendered.
+        pdf_url:
+          type: string
+          description: Hosted URL of the generated PDF.
+        created_at:
+          type: string
+          format: date-time
+          description: When the PDF was generated (ISO 8601).
+        expiration_time:
+          type: string
+          format: date-time
+          description: When the hosted PDF expires (ISO 8601).
+    CsvUploadRequest:
+      type: object
+      description: Multipart form-data request body containing the CSV file to render in bulk.
+      required:
+        - file
+      properties:
+        file:
+          type: string
+          format: binary
+          description: A CSV file uploaded as form-data where each row is one record. One PDF is generated per row.
+    ErrorResponse:
+      type: object
+      description: Standard error envelope returned by the API on failed requests.
+      required:
+        - message
+      properties:
+        error:
+          type: string
+          description: Short error category or exception type.
+        message:
+          type: string
+          description: Human-readable error message describing the failure.
+        path:
+          type: string
+          description: API endpoint path that produced the error.
+        status:
+          type: integer
+          description: HTTP status code returned with the error.
+        timestamp:
+          type: string
+          format: date-time
+          description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
+security:
+  - ApiKeyAuthHeader: []
+  - ApiKeyAuthQuery: []

package/dist/specs/pdf/delete-pdf-page.yaml

@@ -91,6 +91,9 @@ paths:
                     taskId: 04a06cd5-158d-4191-a45b-6f58249c599d
                     inputIds:
                       - 7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters or file ID
           content:
@@ -114,6 +117,9 @@ paths:
                     message: Please provide a valid file ID
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -129,6 +135,9 @@ paths:
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: deletePdfPage
 components:
   securitySchemes:
@@ -188,6 +197,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/linearize-pdf.yaml

@@ -85,6 +85,9 @@ paths:
                     taskId: 8750f9bb-4cb9-45fd-80a6-e1adf6556618
                     inputIds:
                       - 5f214118-f848-41f8-809d-8c6058b4b74a
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid file or file ID
           content:
@@ -108,6 +111,9 @@ paths:
                     timestamp: '2026-07-27T10:55:08.238Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -123,6 +129,9 @@ paths:
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: linearizePdf
 components:
   securitySchemes:
@@ -182,6 +191,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/merge-pdf.yaml

@@ -89,6 +89,9 @@ paths:
                     taskId: 04a06cd5-158d-4191-a45b-6f58249c599d
                     inputIds:
                       - 7a9e4b12-f3c8-4d56-b7e1-8c2f9d0a3e6f
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request
           content:
@@ -112,6 +115,9 @@ paths:
                     message: Please provide either a file or a file ID.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -127,6 +133,9 @@ paths:
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: mergePdf
 components:
   securitySchemes:
@@ -188,6 +197,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-compress.yaml

@@ -98,6 +98,9 @@ paths:
                     taskId: ce4b1a38-6cfc-4373-9bd7-ff186fbd8e7e
                     inputIds:
                       - f2ba4b50-6f8a-43ae-b42d-96937f50cd89
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters or file ID
           content:
@@ -129,6 +132,9 @@ paths:
                     timestamp: '2026-07-27T10:50:25.910Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -144,6 +150,9 @@ paths:
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: compressPdf
 components:
   securitySchemes:
@@ -203,6 +212,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-decrypt.yaml

@@ -91,6 +91,9 @@ paths:
                     taskId: f91ec747-1dc6-4be5-be4b-4d6ff66ed386
                     inputIds:
                       - a5f8aca9-d19a-4ee0-90e3-d15f62df1e06
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters or file ID
           content:
@@ -122,6 +125,9 @@ paths:
                     message: Please provide a valid file ID
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -137,6 +143,9 @@ paths:
                     status: 415
                     error: Unsupported File Type
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: decryptPdf
 components:
   securitySchemes:
@@ -197,6 +206,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-encrypt.yaml

@@ -103,6 +103,9 @@ paths:
                     taskId: c11f7d84-33f5-46da-a64c-e70b3704284e
                     inputIds:
                       - 2d11e722-85cc-4105-b345-f395d48b326e
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters, file ID, or password
           content:
@@ -134,6 +137,9 @@ paths:
                     message: Please provide a valid file ID
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -149,6 +155,9 @@ paths:
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: encryptPdf
 components:
   securitySchemes:
@@ -208,6 +217,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-extract-pages.yaml

@@ -97,6 +97,9 @@ paths:
                     taskId: dabcbcf5-d4ba-4143-bc34-3a8db6c8476e
                     inputIds:
                       - 01a77122-c457-475d-a6f2-f88cd4ad8924
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters or file ID
           content:
@@ -120,6 +123,9 @@ paths:
                     timestamp: '2026-07-27T10:53:19.182Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -135,6 +141,9 @@ paths:
                     message: The provided file type is not supported. Refer to the documentation for valid file types.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: extractPdfPages
 components:
   securitySchemes:
@@ -194,6 +203,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-file-status.yaml

@@ -50,6 +50,9 @@ paths:
                     fileType: pdf
                     fileCreationTime: '2026-07-27T10:46:36'
                     fileDeletionTime: '2026-08-26'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing required file_id parameter
           content:
@@ -65,6 +68,9 @@ paths:
                     timestamp: '2026-07-27T10:46:38.333Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: File ID Not Found
           content:
@@ -80,6 +86,9 @@ paths:
                     message: Please provide a valid file ID.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: getFileStatus
 components:
   securitySchemes:
@@ -143,6 +152,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-file.yaml

@@ -48,6 +48,9 @@ paths:
                     fileId: abc123
                     success: true
                     message: File deleted successfully.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing required file_id parameter
           content:
@@ -63,6 +66,9 @@ paths:
                     timestamp: '2026-07-27T10:45:56.656Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: File ID Not Found
           content:
@@ -78,6 +84,9 @@ paths:
                     message: Please provide a valid file ID.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: deleteFile
 components:
   securitySchemes:
@@ -131,6 +140,11 @@ components:
           type: string
           format: date-time
           description: Timestamp when the error occurred (ISO 8601).
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []

package/dist/specs/pdf/pdf-files.yaml

@@ -44,6 +44,9 @@ paths:
                         fileName: document.pdf
                       - fileId: def456
                         fileName: report.pdf
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: getFiles
 components:
   securitySchemes:
@@ -80,6 +83,11 @@ components:
           type: string
           description: Original name of the uploaded file.
       required: []
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []