@apifreaks/openapi-specs 0.2.0 → 0.3.1

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: []

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

@@ -116,6 +116,9 @@ paths:
                     pdf_url: https://s3.eu-central-2.wasabisys.com/w.storage.apifreaks.com/pdf_templates/73691bce-1c58-4370-acc6-64b2dd14f81c/Candidate%20Resume_20260810141214723405.pdf
                     created_at: '2026-08-10T14:12:17.673Z'
                     expiration_time: '2026-11-10T14:12:17.673Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing or malformed parameters, missing data, or an unreachable data_url.
           content:
@@ -147,6 +150,9 @@ paths:
                     status: 400
                     error: Template Data Not Provided
                     message: No data provided for the template. Please provide valid data to generate pdf.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '401':
           description: Unauthorized — The API key is missing or invalid.
           content:
@@ -162,6 +168,9 @@ paths:
                     path: /v1.0/pdf/template/generate
                     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:
@@ -177,6 +186,9 @@ paths:
                     status: 403
                     error: Template Access Denied
                     message: Your account does not have access to this template.
+          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:
@@ -192,6 +204,9 @@ paths:
                     status: 404
                     error: Template Not Found
                     message: Please provide a valid template ID.
+          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:
@@ -207,6 +222,9 @@ paths:
                     status: 415
                     error: Unsupported Media Type
                     message: The request Content-Type is not supported for this endpoint.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '422':
           description: Unprocessable Entity — The request contains invalid or missing data.
           content:
@@ -222,6 +240,9 @@ paths:
                     status: 422
                     error: Invalid Template Data
                     message: The request contains invalid or missing data.
+          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:
@@ -237,6 +258,9 @@ paths:
                     status: 500
                     error: PDF Generation Failed
                     message: The PDF could not be generated. Try the request again.
+          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:
@@ -252,6 +276,9 @@ paths:
                     status: 504
                     error: Processing Timeout
                     message: The request went past the 100 second processing limit. Reduce the input size or retry.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: generatePdfFromTemplate
 components:
   securitySchemes:
@@ -311,6 +338,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-resource-download.yaml

@@ -46,6 +46,9 @@ paths:
               schema:
                 type: string
                 format: binary
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing required resource_id parameter
           content:
@@ -61,6 +64,9 @@ paths:
                     timestamp: '2026-07-27T10:47:12.356Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Resource ID Not Found
           content:
@@ -76,6 +82,9 @@ paths:
                     message: Please provide a valid resource ID.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: downloadResource
 components:
   securitySchemes:
@@ -112,6 +121,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-resource-upload-binary.yaml

@@ -60,6 +60,9 @@ paths:
                   value:
                     fileName: binarytest.pdf
                     fileId: b0fbf78c-8fe2-49b6-ad3d-63efb4ac8e58
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing file_name or empty body
           content:
@@ -83,6 +86,9 @@ paths:
                     message: Invalid parameter value provided for 'dataBufferFlux'.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File extension not supported
           content:
@@ -98,6 +104,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: uploadResourceBinary
 components:
   securitySchemes:
@@ -147,6 +156,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-resource-upload.yaml

@@ -63,6 +63,9 @@ paths:
                         fileId: 9922d104-25a0-432c-8c26-2be2ba14798a
                       - fileName: test.pdf
                         fileId: 8a6b3332-6fe0-42b0-a808-df7a36926a79
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing or invalid parameters
           content:
@@ -78,6 +81,9 @@ paths:
                     status: 400
                     error: Missing or Invalid Parameters
                     message: One or more required parameters are missing or incorrect.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '415':
           description: Unsupported Media Type — File type not supported
           content:
@@ -93,6 +99,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'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -158,6 +167,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-restrict.yaml

@@ -120,6 +120,9 @@ paths:
                     taskId: 42839406-7e1b-4f64-96bb-d94bb054e8d3
                     inputIds:
                       - 2c682ade-eccc-4ab5-9c06-d16e415cbecb
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters, file ID, or password
           content:
@@ -167,6 +170,9 @@ paths:
                     message: Please provide valid PDF restrictions. Refer to the documentation for valid PDF restrictions.
               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:
@@ -182,6 +188,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: restrictPdf
 components:
   securitySchemes:
@@ -241,6 +250,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-split-pages.yaml

@@ -114,6 +114,9 @@ paths:
                     taskId: a533a95c-b3fb-49f0-abb1-bef2f3e805ef
                     inputIds:
                       - 62f910b6-69ce-4cbc-8285-eee5f16467be
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Invalid file ID
           content:
@@ -129,6 +132,9 @@ paths:
                     timestamp: '2026-07-27T10:54:00.793Z'
               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: splitPdf
 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-task-status.yaml

@@ -67,6 +67,9 @@ paths:
                     error: Invalid Page Range
                     message: One or more specified page numbers exceed the total number of pages in the PDF document.
                     expiresAt: '2026-08-03 10:52:12'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing required task_id parameter
           content:
@@ -82,6 +85,9 @@ paths:
                     timestamp: '2026-07-27T10:49:06.412Z'
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Task ID Not Found
           content:
@@ -97,6 +103,9 @@ paths:
                     message: Please provide a valid task ID.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: getTaskStatus
 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/pdf-to-image.yaml

@@ -116,6 +116,9 @@ paths:
                     taskId: b48e5ed0-e5ce-41bd-953c-6c590ded4b20
                     inputIds:
                       - 6d994947-3909-46cf-91fe-24316c457e2a
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters or file ID
           content:
@@ -163,6 +166,9 @@ paths:
                     message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: pdfToImage
   /pdf/jpg:
     post:
@@ -272,6 +278,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:
@@ -327,6 +336,9 @@ paths:
                     message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
   /pdf/tif:
     post:
       tags:
@@ -431,6 +443,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:
@@ -478,6 +493,9 @@ paths:
                     message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
   /pdf/bmp:
     post:
       tags:
@@ -582,6 +600,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:
@@ -629,6 +650,9 @@ paths:
                     message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
   /pdf/gif:
     post:
       tags:
@@ -734,6 +758,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:
@@ -781,6 +808,9 @@ paths:
                     message: Please provide a valid image resolution(dpi). Refer to the documentation for valid resolution values.
               schema:
                 $ref: '#/components/schemas/ErrorResponse'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
 components:
   securitySchemes:
     ApiKeyAuthHeader:
@@ -839,6 +869,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-unrestrict.yaml

@@ -103,6 +103,9 @@ paths:
                     taskId: 16cc979a-55b9-476c-bfef-0977314478ec
                     inputIds:
                       - 9c809ef8-583a-40f1-afe2-424d1d953b69
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters, file ID, or password
           content:
@@ -142,6 +145,9 @@ paths:
                     message: Please provide a strong password. Refer to the documentation for password requirements.
               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:
@@ -157,6 +163,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: unrestrictPdf
 components:
   securitySchemes:
@@ -216,6 +225,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/rotate-pdf-pages.yaml

@@ -97,6 +97,9 @@ paths:
                     taskId: b59d27fa-9865-4ad8-8e7c-818eb263892b
                     inputIds:
                       - 0fb39c16-db08-4ac8-bb5f-51656f934aaa
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request — Missing/invalid parameters or file ID
           content:
@@ -128,6 +131,9 @@ paths:
                     timestamp: '2026-07-27T10:54:38.253Z'
               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:
@@ -143,6 +149,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: rotatePdfPages
 components:
   securitySchemes:
@@ -202,6 +211,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/phone-validation/bulk-phone-number-validation.yaml

@@ -125,6 +125,9 @@ paths:
                       valid: false
                       error: Invalid Number Format
                       message: The input does not match the expected structure of a phone number.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '400':
           description: Bad Request – Missing or malformed request body
           content:
@@ -140,6 +143,9 @@ paths:
                     path: /v1.0/phone/validation/bulk
                     status: 400
                     timestamp: '2026-07-27T12:56:50.387Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '404':
           description: Not Found – Wrong HTTP method used on the endpoint (e.g. GET instead of POST)
           content:
@@ -155,6 +161,9 @@ paths:
                     path: /v1.0/phone/validation/bulk
                     status: 404
                     timestamp: '2026-07-27T12:58:41.535Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '408':
           description: Request Timeout – Timed out while connecting to the remote server
           content:
@@ -170,6 +179,9 @@ paths:
                     status: 408
                     error: Request Timeout
                     message: Timed out while connecting to the remote URL.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '413':
           description: Payload Too Large – Request body exceeds the size limit
           content:
@@ -185,6 +197,9 @@ paths:
                     path: /v1.0/phone/validation/bulk
                     status: 413
                     timestamp: '2026-07-27T12:57:03.711Z'
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
         '429':
           description: Rate Limit Exceeded – API rate limit exceeded
           content:
@@ -200,6 +215,9 @@ paths:
                     status: 429
                     error: Too Many Requests
                     message: API rate limit exceeded.
+          headers:
+            X-AF-Credits-Cost:
+              $ref: '#/components/headers/X-AF-Credits-Cost'
       operationId: bulkValidatePhoneNumbers
 components:
   securitySchemes:
@@ -369,6 +387,11 @@ components:
       description: Standard error envelope returned by the API on failed requests.
       required:
         - message
+  headers:
+    X-AF-Credits-Cost:
+      description: Specifies the number of credits consumed by the current request.
+      schema:
+        type: integer
 security:
   - ApiKeyAuthHeader: []
   - ApiKeyAuthQuery: []