Pelaikan API Documentation

One Go Endpoint

Use POST /v1/verify_pdf when you want the server to run OCR, parse citations, resolve sources, and analyze congruence in one request. The response is a Server-Sent Events stream, so clients receive progress and result rows as work completes.

Config

The config form field is JSON. You can also fetch the live schema from GET /v1/verify_pdf/config-schema.

cURL

curl -N -X POST "$API_BASE/v1/verify_pdf" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -F "file=@brief.pdf;type=application/pdf" \
  -F "document_id=brief-2026-06-05" \
  -F 'config={
    "allowed_kinds": ["precedent", "legal_norm"],
    "include_footnotes": true,
    "include_inline": true,
    "inline_pages": [1, 2, 3],
    "max_footnotes": 20,
    "max_inline": 30,
    "concurrency": 4
  }'

JavaScript

async function verifyPdf({ apiBase, accessToken, file, documentId }) {
  const form = new FormData();
  form.append("file", file);
  form.append("document_id", documentId);
  form.append("config", JSON.stringify({
    allowed_kinds: ["precedent", "legal_norm"],
    include_footnotes: true,
    include_inline: true,
    require_claim: true,
    concurrency: 4,
  }));

  const response = await fetch(`${apiBase}/v1/verify_pdf`, {
    method: "POST",
    headers: { Authorization: `Bearer ${accessToken}` },
    body: form,
  });

  const reader = response.body
    .pipeThrough(new TextDecoderStream())
    .getReader();

  let buffer = "";
  const rows = [];
  let summary = null;

  while (true) {
    const { value, done } = await reader.read();
    if (done) break;
    buffer += value;

    const chunks = buffer.split("\n\n");
    buffer = chunks.pop() || "";

    for (const chunk of chunks) {
      const event = chunk.match(/^event: (.+)$/m)?.[1];
      const dataLine = chunk.match(/^data: (.+)$/m)?.[1];
      if (!event || !dataLine) continue;
      const data = JSON.parse(dataLine);

      if (event === "row") rows.push(data);
      if (event === "complete") summary = data.summary;
      if (event === "error") throw new Error(data.detail || data.error);
    }
  }

  return { rows, summary };
}

Stream Events

This endpoint is synchronous from the client's point of view, but it streams progress to avoid holding a silent long-running request. Keep the HTTP connection open until the complete event arrives.

Workflow

The API follows the same four-stage split as the root walkthrough notebook.

1. Upload a PDF and extract pages plus footnotes.
2. Parse citations from a footnote or from inline page text.
3. Resolve one citation to an actual source.
4. Analyze whether the source supports the claim.

curl -X POST "$API_BASE/web/audit/resolve" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "citation": { "...": "one parsed citation" },
    "document_id": "example-document",
    "data_source": "internet",
    "internet_policy": "smart",
    "parsed_citations": []
      }'

Web App Endpoints

Use these endpoints for the Firebase-hosted web app and for normal HTTP API clients. They store OCR and verification cache data in cloud storage under the authenticated user.

Documents, Reports, and Cached Files

These endpoints manage the authenticated user's document registry, generated reports, OCR cache files, and database artifacts.

Batch Endpoints

Specialized Endpoints

Desktop and Bridge Routes

The plain /pdf/* and /audit/* routes mirror much of the web workflow, but they are designed for the desktop app, Word add-in, local catalog databases, and bridge clients. Use the /web/* routes for hosted HTTP API clients unless you are explicitly integrating with the desktop bridge.

Bridge routes can require a live desktop client, a matching token client id, and local database paths. For hosted web usage, prefer the web workflow above.

Errors and Operational Notes

• 401: missing or invalid bearer token, or no user id in the token.
• 402: insufficient credits before /web/audit/analyze.
• 403: authenticated but not allowed for the requested scoped operation.
• 404: document, report, OCR cache, or database artifact was not found.
• 413: proxied PDF exceeds the allowed size.
• 415: proxied URL did not return a PDF.
• 500/502: backend, upstream fetch, OCR, LLM, or bridge failure.

Long-running endpoints can take several minutes. Keep client timeouts high for OCR, resolution, and analysis, and consume streaming endpoints as text/event-stream.