@pdfvector/instance-contract 0.0.23 → 0.0.25

package/.tsc/lib/router/academic/fetch.d.ts

@@ -16,6 +16,10 @@ export declare const fetch: import("@orpc/contract").ContractProcedureBuilderWit
         provider: "provider";
         providerData: "providerData";
     }>>>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     results: z.ZodArray<z.ZodObject<{
         id: z.ZodString;

package/.tsc/lib/router/academic/fetch.js

@@ -78,6 +78,21 @@ export const fetch = oc
     })
         .nullish()
         .describe("Specific publication fields to return. If omitted, returns all fields except providerData."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 }))
     .output(z.object({
     results: z.array(publicationSchema),

package/.tsc/lib/router/academic/find-citations.d.ts

@@ -25,6 +25,10 @@ export declare const findCitations: import("@orpc/contract").ContractProcedureBu
         provider: "provider";
         providerData: "providerData";
     }>>>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     results: z.ZodArray<z.ZodObject<{
         sentence: z.ZodString;

package/.tsc/lib/router/academic/find-citations.js

@@ -83,6 +83,21 @@ export const findCitations = oc
     })
         .nullish()
         .describe("Specific citation fields to return. If omitted, returns all fields except providerData."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 }))
     .output(z.object({
     results: z.array(sentenceCitationSchema),

package/.tsc/lib/router/academic/search.d.ts

@@ -29,6 +29,10 @@ export declare const search: import("@orpc/contract").ContractProcedureBuilderWi
         provider: "provider";
         providerData: "providerData";
     }>>>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     estimatedTotalResults: z.ZodNumber;
     results: z.ZodArray<z.ZodObject<{

package/.tsc/lib/router/academic/search.js

@@ -122,6 +122,21 @@ export const search = oc
     })
         .nullish()
         .describe("Specific publication fields to return. If omitted, returns all fields except providerData."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 }))
     .output(z.object({
     estimatedTotalResults: z.number(),

package/.tsc/lib/router/bankStatement/ask.d.ts

@@ -11,14 +11,20 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/bankStatement/ask.js

@@ -37,10 +37,30 @@ const askInputSchema = z.object({
         "'mini': Uses mid-range models. " +
         "'pro': Uses capable models. " +
         "'max': Uses the most powerful models."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const askOutputSchema = z.object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/bankStatement/extract.d.ts

@@ -12,14 +12,20 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/bankStatement/extract.js

@@ -63,12 +63,32 @@ const extractInputSchema = z.object({
         "'mini': Uses mid-range models. " +
         "'pro': Uses capable models. " +
         "'max': Uses the most powerful models."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const extractOutputSchema = z.object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/bankStatement/parse.d.ts

@@ -8,6 +8,10 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
     pageCount: z.ZodNumber;
@@ -15,6 +19,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     html: z.ZodOptional<z.ZodString>;
     documentId: z.ZodOptional<z.ZodString>;

package/.tsc/lib/router/bankStatement/parse.js

@@ -32,6 +32,21 @@ const parseInputSchema = z.object({
         "'auto' (default): Automatically selects the best parsing strategy with intelligent fallback. " +
         "'pro': Extracts structured bank statement fields with standard accuracy. " +
         "'max': Extracts structured bank statement fields with highest accuracy and fallback."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const parseOutputSchema = z.object({
     markdown: z
@@ -41,6 +56,10 @@ const parseOutputSchema = z.object({
     model: z
         .enum(["pro", "max"])
         .describe("Model tier used to parse the bank statement"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/document/ask.d.ts

@@ -11,14 +11,20 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
         max: "max";
         auto: "auto";
     }>>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/document/ask.js

@@ -38,15 +38,38 @@ const askInputSchema = z.object({
         "'mini': Uses mid-range models (likely better than GPT-5-mini). Supports PDF, Word, Excel, CSV. " +
         "'pro': Uses capable models (likely better than GPT-5.2). Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Uses the most powerful models (likely better than Claude Opus 4.6). Supports PDF, Word, Excel, CSV, Image."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const askOutputSchema = z
     .object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z
+        .number()
+        .int()
+        .describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question. " +
         "'nano': Supports PDF, Word, Excel, CSV. " +
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()
@@ -60,7 +83,9 @@ const askOutputSchema = z
     examples: [
         {
             markdown: "The study found that viral shedding peaked during the first week of symptoms, with the highest viral loads detected in throat swabs.",
+            pageCount: 12,
             model: "mini",
+            credits: 48,
             requestId: 1,
         },
     ],

package/.tsc/lib/router/document/extract.d.ts

@@ -12,14 +12,20 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
         max: "max";
         auto: "auto";
     }>>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/document/extract.js

@@ -65,17 +65,40 @@ const extractInputSchema = z.object({
         "'mini': Uses mid-range models (likely better than GPT-5-mini). Supports PDF, Word, Excel, CSV. " +
         "'pro': Uses capable models (likely better than GPT-5.2). Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Uses the most powerful models (likely better than Claude Opus 4.6). Supports PDF, Word, Excel, CSV, Image."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const extractOutputSchema = z
     .object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z
+        .number()
+        .int()
+        .describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data. " +
         "'nano': Supports PDF, Word, Excel, CSV. " +
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()
@@ -93,7 +116,9 @@ const extractOutputSchema = z
                 authors: ["Roman Wölfel", "Victor M. Corman"],
                 year: 2020,
             },
+            pageCount: 12,
             model: "mini",
+            credits: 48,
             requestId: 1,
         },
     ],

package/.tsc/lib/router/document/parse.d.ts

@@ -10,6 +10,10 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         max: "max";
         auto: "auto";
     }>>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
     pageCount: z.ZodNumber;
@@ -19,6 +23,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     html: z.ZodOptional<z.ZodString>;
     documentId: z.ZodOptional<z.ZodString>;

package/.tsc/lib/router/document/parse.js

@@ -34,6 +34,21 @@ const parseInputSchema = z.object({
         "'mini': For documents with tables and structured content. File up to 30 pages, up to 10MB in size. Supports PDF, Word, Excel, CSV. " +
         "'pro': For documents up to 30 pages with tables, handwritten text, figures, math, and Arabic. File up to 30 pages, up to 40MB in size. Supports PDF, Word, Excel, CSV, Image. " +
         "'max': For large documents with full Pro capabilities plus enhanced multilingual support. File up to 1000 pages, up to 500MB in size. Supports PDF, Word, Excel, CSV, Image."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const parseOutputSchema = z.object({
     markdown: z.string().describe("Extracted text content from the document"),
@@ -43,6 +58,10 @@ const parseOutputSchema = z.object({
         "'mini': Supports PDF, Word, Excel, CSV. " +
         "'pro': Supports PDF, Word, Excel, CSV, Image. " +
         "'max': Supports PDF, Word, Excel, CSV, Image."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/identity/ask.d.ts

@@ -11,14 +11,20 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/identity/ask.js

@@ -37,10 +37,30 @@ const askInputSchema = z.object({
         "'mini': Uses mid-range models. " +
         "'pro': Uses capable models. " +
         "'max': Uses the most powerful models."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const askOutputSchema = z.object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/identity/extract.d.ts

@@ -12,14 +12,20 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/identity/extract.js

@@ -63,12 +63,32 @@ const extractInputSchema = z.object({
         "'mini': Uses mid-range models. " +
         "'pro': Uses capable models. " +
         "'max': Uses the most powerful models."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const extractOutputSchema = z.object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/identity/parse.d.ts

@@ -8,6 +8,10 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
     pageCount: z.ZodNumber;
@@ -17,6 +21,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
     }>;
     documentType: z.ZodOptional<z.ZodString>;
     html: z.ZodOptional<z.ZodString>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/identity/parse.js

@@ -32,6 +32,21 @@ const parseInputSchema = z.object({
         "'auto' (default): Automatically selects the best parsing strategy with intelligent fallback. " +
         "'pro': Extracts structured identity document fields with standard accuracy. " +
         "'max': Extracts structured identity document fields with highest accuracy."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const parseOutputSchema = z.object({
     markdown: z
@@ -50,6 +65,10 @@ const parseOutputSchema = z.object({
         .optional()
         .describe("Full HTML representation of the document content. Only available when using the 'max' model. " +
         "Preserves rich formatting, tables, selection marks, and visual layout that cannot be fully represented in markdown."),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/invoice/ask.d.ts

@@ -11,14 +11,20 @@ export declare const ask: import("@orpc/contract").ContractProcedureBuilderWithI
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/invoice/ask.js

@@ -34,10 +34,30 @@ const askInputSchema = z.object({
         "'mini': Uses mid-range models. " +
         "'pro': Uses capable models. " +
         "'max': Uses the most powerful models."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const askOutputSchema = z.object({
     markdown: z.string().describe("The answer to the question"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to answer the question"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/invoice/extract.d.ts

@@ -12,14 +12,20 @@ export declare const extract: import("@orpc/contract").ContractProcedureBuilderW
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     data: z.ZodUnknown;
+    pageCount: z.ZodNumber;
     model: z.ZodEnum<{
         nano: "nano";
         mini: "mini";
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     documentId: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>, Record<never, never>, Record<never, never>>;

package/.tsc/lib/router/invoice/extract.js

@@ -60,12 +60,32 @@ const extractInputSchema = z.object({
         "'mini': Uses mid-range models. " +
         "'pro': Uses capable models. " +
         "'max': Uses the most powerful models."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const extractOutputSchema = z.object({
     data: z
         .unknown()
         .describe("Extracted structured data matching the provided JSON Schema"),
+    pageCount: z.number().int().describe("Total number of pages in the document"),
     model: pdfvectorModelSchema.describe("Model tier used to extract the data"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/.tsc/lib/router/invoice/parse.d.ts

@@ -8,6 +8,10 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         max: "max";
         auto: "auto";
     }>>;
+    callback: z.ZodOptional<z.ZodObject<{
+        url: z.ZodURL;
+        type: z.ZodOptional<z.ZodString>;
+    }, z.core.$strip>>;
 }, z.core.$strip>, z.ZodObject<{
     markdown: z.ZodString;
     pageCount: z.ZodNumber;
@@ -15,6 +19,7 @@ export declare const parse: import("@orpc/contract").ContractProcedureBuilderWit
         pro: "pro";
         max: "max";
     }>;
+    credits: z.ZodNumber;
     requestId: z.ZodNumber;
     html: z.ZodOptional<z.ZodString>;
     documentId: z.ZodOptional<z.ZodString>;

package/.tsc/lib/router/invoice/parse.js

@@ -29,6 +29,21 @@ const parseInputSchema = z.object({
         "'auto' (default): Automatically selects the best parsing strategy with intelligent fallback. " +
         "'pro': Extracts structured invoice fields with standard accuracy. " +
         "'max': Extracts structured invoice fields with highest accuracy and fallback."),
+    callback: z
+        .object({
+        url: z
+            .url()
+            .describe("Webhook URL where results will be POSTed when processing completes"),
+        type: z
+            .string()
+            .optional()
+            .describe("Callback type identifier (e.g. 'zapier')"),
+    })
+        .optional()
+        .describe("Optional webhook callback for async processing. " +
+        "When provided, the server returns 202 immediately and POSTs the full response payload to the callback URL when processing completes. " +
+        "On error, the callback receives a POST with X-Pdfvector-Callback-Failed: true header and error details in the body. " +
+        "Useful for long-running operations that may exceed client timeout limits."),
 });
 const parseOutputSchema = z.object({
     markdown: z.string().describe("Extracted text content from the invoice"),
@@ -36,6 +51,10 @@ const parseOutputSchema = z.object({
     model: z
         .enum(["pro", "max"])
         .describe("Model tier used to parse the invoice"),
+    credits: z
+        .number()
+        .int()
+        .describe("Number of credits consumed by this API call"),
     requestId: z
         .number()
         .int()

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @pdfvector/instance-contract
 
+## 0.0.25
+### Patch Changes
+
+
+
+- [#135](https://github.com/phuctm97/pdfvector/pull/135) [`732ce5a`](https://github.com/phuctm97/pdfvector/commit/732ce5a843716075fa17c2ae64525b21919b0a3c) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Add Zapier integration package with callback support and CI/CD release workflow
+
+## 0.0.24
+### Patch Changes
+
+
+
+- [#133](https://github.com/phuctm97/pdfvector/pull/133) [`953cf32`](https://github.com/phuctm97/pdfvector/commit/953cf328a9eb30dd4dff3f40fd68dbfe4078901d) Thanks [@khanhduyvt0101](https://github.com/khanhduyvt0101)! - Add credits and pageCount to API responses, deduplicate ask/extract handlers, and improve extract prompt
+
 ## 0.0.23
 ### Patch Changes
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pdfvector/instance-contract",
-  "version": "0.0.23",
+  "version": "0.0.25",
   "type": "module",
   "description": "API contract definitions for PDFVector instance server",
   "license": "MIT",