Build on top of
Forge infrastructure.

Quickstart

Get started with the Forge API in under 5 minutes. This guide walks you through authentication, your first API call, and basic integration patterns.

const forge = new Forge({ apiKey: 'YOUR_API_KEY' });

const result = await forge.dil.process({
  document: 'invoice.pdf',
  type: 'invoice'
});

console.log(result.data);
// { vendor: 'Acme Corp', amount: 1250.00, date: '2024-01-15', ... }

Authentication

All Forge API requests require authentication via an API key. Include your API key in the Authorization header using Bearer token authentication.

SDK Installation

Forge provides official SDKs for popular languages. The SDKs handle authentication, error handling, and provide type-safe interfaces for all API endpoints.

import { Forge } from '@imhotep/forge-js';

const forge = new Forge({ apiKey: process.env.FORGE_API_KEY });

from imhotep_forge import Forge

forge = Forge(api_key=os.environ['FORGE_API_KEY'])

Code Examples

Practical examples for common integration patterns. These examples demonstrate how to combine DIL, REOL, and SEL to build intelligent workflows.

// Process document with DIL
const extracted = await forge.dil.process({
  document: uploadedFile,
  type: 'contract'
});

// Apply reasoning with REOL
const analysis = await forge.reol.analyze({
  data: extracted.data,
  context: 'contract_review'
});

// Trigger SEL workflow if conditions met
if (analysis.risk_score > 0.7) {
  await forge.sel.trigger({
    workflow: 'high_risk_review',
    data: analysis
  });
}

const documents = await fetchDocuments();

const results = await Promise.all(
  documents.map(doc => 
    forge.dil.process({ document: doc, type: 'invoice' })
  )
);

// Aggregate results
const summary = aggregateResults(results);

Webhooks

Configure webhooks to receive real-time notifications about async operations, workflow events, and system status updates.

Rate Limits

API rate limits ensure fair access and system stability. Limits are applied per API key and vary based on your plan tier.

Rate limit headers are included in all API responses:

X-RateLimit-Limit: 300
X-RateLimit-Remaining: 295
X-RateLimit-Reset: 1640995200