Quickstart

pip install thedriveai

npm install @thedriveai/sdk

from thedriveai import TheDriveAI

client = TheDriveAI(api_key="tda_live_...")

result = client.extract(
    file="invoice.pdf",
    schema={
        "invoice_number": {"type": "string", "description": "The invoice number"},
        "vendor": {"type": "string", "description": "Company name"},
        "total": {"type": "number", "description": "Total amount due"},
        "is_paid": {"type": "boolean", "description": "Whether the invoice is marked as paid"},
    },
)

print(result.data)
# {"invoice_number": "INV-2024-0042", "vendor": "Acme Corp", "total": 1234.56, "is_paid": false}

print(result.confidence)
# {"invoice_number": 0.96, "vendor": 0.94, "total": 0.91, "is_paid": 0.85}

import { TheDriveAI } from "@thedriveai/sdk";
import { readFileSync } from "fs";

const client = new TheDriveAI({ apiKey: "tda_live_..." });

const result = await client.extract({
  file: readFileSync("invoice.pdf"),
  schema: {
    invoice_number: { type: "string", description: "The invoice number" },
    vendor: { type: "string", description: "Company name" },
    total: { type: "number", description: "Total amount due" },
    is_paid: { type: "boolean", description: "Whether the invoice is marked as paid" },
  },
});

console.log(result.data);
// { invoice_number: "INV-2024-0042", vendor: "Acme Corp", total: 1234.56, is_paid: false }

curl -X POST https://dev.thedrive.ai/api/v1/extract \
  -H "X-API-Key: tda_live_..." \
  -F file=@invoice.pdf \
  -F 'schema={
    "invoice_number": {"type": "string", "description": "The invoice number"},
    "vendor": {"type": "string", "description": "Company name"},
    "total": {"type": "number", "description": "Total amount due"}
  }'

from pydantic import BaseModel, Field
from thedriveai import TheDriveAI

class Invoice(BaseModel):
    invoice_number: str = Field(description="The invoice number")
    vendor: str = Field(description="Company name")
    total: float = Field(description="Total amount due")
    is_paid: bool = Field(description="Whether the invoice is marked as paid")

client = TheDriveAI(api_key="tda_live_...")
result = client.extract(file="invoice.pdf", schema=Invoice)

print(result.data["vendor"])  # "Acme Corp"
print(result.data["total"])   # 1234.56

import { TheDriveAI, fromZod } from "@thedriveai/sdk";
import { readFileSync } from "fs";
import { z } from "zod";

const Invoice = z.object({
  invoice_number: z.string().describe("The invoice number"),
  vendor: z.string().describe("Company name"),
  total: z.number().describe("Total amount due"),
  is_paid: z.boolean().describe("Whether the invoice is marked as paid"),
});

const client = new TheDriveAI({ apiKey: "tda_live_..." });
const result = await client.extract({
  file: readFileSync("invoice.pdf"),
  schema: fromZod(Invoice),
});

console.log(result.data.vendor); // "Acme Corp"
console.log(result.data.total);  // 1234.56

result = client.extract(
    url="https://example.com/pricing",
    schema={
        "plans": {
            "type": "array",
            "description": "Available pricing plans",
            "items": {
                "type": "object",
                "properties": {
                    "name": {"type": "string", "description": "Plan name"},
                    "price": {"type": "number", "description": "Monthly price"},
                }
            }
        }
    },
)

const result = await client.extract({
  url: "https://example.com/pricing",
  schema: {
    plans: {
      type: "array",
      description: "Available pricing plans",
      items: {
        type: "object",
        properties: {
          name: { type: "string", description: "Plan name" },
          price: { type: "number", description: "Monthly price" },
        },
      },
    },
  },
});

from thedriveai import TheDriveAI, TheDriveAIError

try:
    result = client.extract(file="doc.pdf", schema={...})
except TheDriveAIError as e:
    print(e.status_code)  # 400, 413, 503, etc.
    print(e.detail)       # Error detail from the API

import { TheDriveAI, TheDriveAIError } from "@thedriveai/sdk";

try {
  const result = await client.extract({...});
} catch (e) {
  if (e instanceof TheDriveAIError) {
    console.log(e.statusCode); // 400, 413, 503, etc.
    console.log(e.detail);     // Error detail from the API
  }
}