Quickstart

Head to boreholeai.com/signup and create a free account with your email address. Every new account receives free credits to get started — no payment required.

If you just want to explore without signing up, try the Playground — it includes pre-loaded demo borehole logs you can interact with immediately.

Navigate to Settings → API Keys in the dashboard and create a new API key. Copy it immediately — it will only be shown once. Your API key starts with bhai_.

Keep your API key secure. Do not commit it to version control or share it publicly. You can revoke a key at any time from the API Keys settings page and create a new one.

Install the boreholeai package from PyPI. Requires Python 3.9 or later.

pip install boreholeai

Create a Python script and pass your borehole log PDF to the client. The SDK handles uploading, processing, polling for results, and downloading output files.

from boreholeai import BoreholeAI

client = BoreholeAI(api_key="bhai_your_api_key_here")

# Process a single borehole log
result = client.process_documents("BH01.pdf", output_dir="./results")

print(f"Pages processed: {result.num_pages}")
print(f"Credits used: {result.credits_used}")

for f in result.files:
    print(f"  {f.filename} → {f.path}")

When processing completes, you will find the following files in your ./results directory:

• Borehole_ground_profile.xlsx — structured ground profile table
• Borehole_test_data.xlsx — all test results in tabular format
• Borehole_ags4.ags — industry-standard AGS4 data transfer file
• BH01_annotated.pdf — original document with extracted regions highlighted

Pass a directory path to process multiple files together. Results are merged into a single ground profile Excel, test data Excel, and AGS file, with one annotated PDF per input file.

result = client.process_documents("./borehole_logs/", output_dir="./results")

# Output files:
#   Borehole_ground_profile.xlsx   (merged from all input files)
#   Borehole_test_data.xlsx        (merged from all input files)
#   Borehole_ags4.ags              (merged from all input files)
#   BH01_annotated.pdf             (one per input file)
#   BH02_annotated.pdf
#   BH03_annotated.pdf