API Documentation

npx skills add https://github.com/doc-api-llc/docapi-skill --skill docapi

DOCAPI_KEY=pk_...                                           # API key
DOCAPI_USDC_ADDRESS=0x2B984ee1A172B0aB50eDAf59FeA11D3ddc4e4396  # payment address

npm install @docapi/sdk

import { DocAPI } from "@docapi/sdk";

const client = new DocAPI(process.env.DOCAPI_KEY!);

// Generate a PDF
const pdf = await client.pdf("<h1>Hello World</h1>", { format: "A4" });
fs.writeFileSync("output.pdf", pdf);

// Screenshot a URL
const img = await client.screenshot({ url: "https://example.com", width: 1200, height: 630 });
fs.writeFileSync("screenshot.png", img);

// Screenshot from HTML (e.g. OG image)
const og = await client.screenshot({
  html: `<div style="width:1200px;height:630px;background:#0f172a;
                      display:flex;align-items:center;padding:80px">
           <h1 style="color:white;font-size:64px">My Post Title</h1>
         </div>`,
  width: 1200,
  height: 630,
});

const pdf = await client.pdf(html);
if ((client.creditsRemaining ?? 999) < 50) {
  // trigger USDC top-up
}

import { DocAPI } from "@docapi/sdk";

// No API key needed — static method
const account = await DocAPI.register({ notify_email: "[email protected]" });
console.log(account.api_key);      // "pk_..."
console.log(account.usdc_address); // "0x..."
console.log(account.free_calls);   // 10

import { DocAPI, DocAPIError } from "@docapi/sdk";

try {
  const pdf = await client.pdf(html);
} catch (err) {
  if (err instanceof DocAPIError) {
    console.error(err.status); // 401 | 402 | 429 | 500
    console.error(err.code);   // "invalid_api_key" | "credits_exhausted" | ...
  }
}

pip install docapi-sdk

from docapi import DocAPI

client = DocAPI("pk_live_...")

# Generate a PDF
pdf = client.pdf("<h1>Hello World</h1>", format="A4")
with open("output.pdf", "wb") as f:
    f.write(pdf)

# Screenshot a URL
img = client.screenshot(url="https://example.com", width=1200, height=630)
with open("screenshot.png", "wb") as f:
    f.write(img)

# Screenshot from HTML (e.g. OG image)
og = client.screenshot(
    html="""<div style="width:1200px;height:630px;background:#0f172a;
                        display:flex;align-items:center;padding:80px">
              <h1 style="color:white;font-size:64px">My Post Title</h1>
            </div>""",
    width=1200,
    height=630,
)

pdf = client.pdf(html)
if (client.credits_remaining or 999) < 50:
    # trigger USDC top-up
    pass

from docapi import DocAPI

# No API key needed — static method
account = DocAPI.register(notify_email="[email protected]")
print(account["api_key"])       # "pk_..."
print(account["usdc_address"])  # "0x..."
print(account["free_calls"])    # 10

from docapi import DocAPI, DocAPIError

try:
    pdf = client.pdf(html)
except DocAPIError as e:
    print(e.status)   # 401 | 402 | 429 | 500
    print(e.code)     # "invalid_api_key" | "credits_exhausted" | ...
    print(e.message)

curl -X POST https://api.docapi.co/v1/pdf \
  -H "x-api-key: pk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{"html": "<h1>Hello World</h1>"}' \
  --output document.pdf

x-api-key: pk_live_your_api_key_here

curl -X POST https://www.docapi.co/api/register \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "notify_email": "[email protected]"
  }'

{
  "api_key": "pk_4a7f2b9c1d3e...",
  "usdc_address": "0x2B984ee1A172B0aB50eDAf59FeA11D3ddc4e4396",
  "free_calls": 10,
  "credits_per_usdc": 50,
  "network": "base-mainnet",
  "rate": "$0.02 per API call",
  "auto_topup": {
    "header": "X-Credits-Remaining",
    "recommended_threshold": 50,
    "recommended_topup_usdc": 10
  },
  "on_exhausted": {
    "http_status": 402,
    "body": { "error": "credits_exhausted", "usdc_address": "0x..." }
  },
  "notifications": {
    "low_balance_email": "[email protected]",
    "threshold": 50,
    "note": "One email per 24h when credits fall below threshold"
  },
  "docs": "https://www.docapi.co/docs"
}

curl https://www.docapi.co/api/topup \
  -H "x-api-key: pk_4a7f2b9c1d3e..."

{
  "credits": 487,
  "usdc_address": "0x2B984ee1A172B0aB50eDAf59FeA11D3ddc4e4396",
  "rate": "$0.02 per call (50 credits per USDC)",
  "suggested_topup_usdc": 10
}

HTTP/2 200
Content-Type: application/pdf
X-Credits-Remaining: 47

import requests
from coinbase_agentkit import CdpAgentkitWrapper

API_KEY = "pk_..."
USDC_ADDRESS = "0x..."  # from registration response
THRESHOLD = 50
TOPUP_USDC = 10

agentkit = CdpAgentkitWrapper()
_topup_pending = False

def generate_pdf(html: str) -> bytes:
    global _topup_pending
    resp = requests.post(
        "https://api.docapi.co/v1/pdf",
        headers={"x-api-key": API_KEY},
        json={"html": html},
        timeout=30,
    )

    remaining = int(resp.headers.get("X-Credits-Remaining", 999))
    if remaining < THRESHOLD and not _topup_pending:
        _topup_pending = True
        try:
            agentkit.run(f"Send {TOPUP_USDC} USDC to {USDC_ADDRESS} on base-mainnet")
        finally:
            _topup_pending = False

    resp.raise_for_status()
    return resp.content

import { sendUsdc } from '@coinbase/agentkit';

const API_KEY = 'pk_...';
const USDC_ADDRESS = '0x...'; // from registration response
const THRESHOLD = 50;
const TOPUP_USDC = 10;

let topupInProgress = false;

async function generatePdf(html) {
  const res = await fetch('https://api.docapi.co/v1/pdf', {
    method: 'POST',
    headers: { 'x-api-key': API_KEY, 'Content-Type': 'application/json' },
    body: JSON.stringify({ html }),
  });

  const remaining = parseInt(res.headers.get('X-Credits-Remaining') ?? '999');
  if (remaining < THRESHOLD && !topupInProgress) {
    topupInProgress = true;
    sendUsdc({ to: USDC_ADDRESS, amount: TOPUP_USDC, network: 'base-mainnet' })
      .catch(console.error)
      .finally(() => { topupInProgress = false; });
  }

  if (!res.ok) throw new Error(`DocAPI error: ${res.status}`);
  return res.arrayBuffer();
}

{
  "error": {
    "code": "usage_limit_exceeded",
    "message": "You have exceeded your monthly API call limit."
  }
}

curl -X POST https://api.docapi.co/v1/pdf \
  -H "x-api-key: pk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "html": "<html><body><h1>Invoice #123</h1><p>Amount: $99.00</p></body></html>",
    "options": {
      "format": "A4",
      "margin": { "top": "0.5in", "bottom": "0.5in" }
    }
  }' \
  --output invoice.pdf

const fs = require('fs');

async function generatePDF() {
  const response = await fetch('https://api.docapi.co/v1/pdf', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.DOC_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      html: `
        <html>
          <head>
            <style>
              body { font-family: Arial, sans-serif; padding: 40px; }
              h1 { color: #333; }
            </style>
          </head>
          <body>
            <h1>Invoice #123</h1>
            <p>Amount: $99.00</p>
          </body>
        </html>
      `,
      options: { format: 'A4' }
    })
  });

  if (!response.ok) {
    const error = await response.json();
    throw new Error(error.error.message);
  }

  const pdf = await response.arrayBuffer();
  fs.writeFileSync('invoice.pdf', Buffer.from(pdf));
  console.log('PDF saved!');
}

generatePDF();

import requests
import os

def generate_pdf():
    response = requests.post(
        'https://api.docapi.co/v1/pdf',
        headers={
            'x-api-key': os.environ['DOC_API_KEY'],
            'Content-Type': 'application/json'
        },
        json={
            'html': '''
                <html>
                <head>
                    <style>
                        body { font-family: Arial, sans-serif; padding: 40px; }
                        h1 { color: #333; }
                    </style>
                </head>
                <body>
                    <h1>Invoice #123</h1>
                    <p>Amount: $99.00</p>
                </body>
                </html>
            ''',
            'options': {'format': 'A4'}
        }
    )

    if response.status_code != 200:
        raise Exception(response.json()['error']['message'])

    with open('invoice.pdf', 'wb') as f:
        f.write(response.content)

    print('PDF saved!')

generate_pdf()

<?php

$apiKey = getenv('DOC_API_KEY');

$data = [
    'html' => '
        <html>
        <head>
            <style>
                body { font-family: Arial, sans-serif; padding: 40px; }
                h1 { color: #333; }
            </style>
        </head>
        <body>
            <h1>Invoice #123</h1>
            <p>Amount: $99.00</p>
        </body>
        </html>
    ',
    'options' => ['format' => 'A4']
];

$ch = curl_init('https://api.docapi.co/v1/pdf');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'x-api-key: ' . $apiKey,
        'Content-Type: application/json'
    ],
    CURLOPT_POSTFIELDS => json_encode($data)
]);

$response = curl_exec($ch);
$httpCode = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);

if ($httpCode !== 200) {
    $error = json_decode($response, true);
    throw new Exception($error['error']['message']);
}

file_put_contents('invoice.pdf', $response);
echo "PDF saved!\n";