Skip to content

🧭 SDKs — Overview

Overview

AIForged SDKs provide a typed, developer-friendly way to integrate programmatically with the platform. Use the SDK when you want language-native models, resilient client patterns, and discoverable operations. Use the REST API directly when you need polyglot scripting, ultra-light dependencies, or raw HTTP access.

What this page helps you do

Pick an SDK, understand the typical development flow, and jump into the right quick start or how‑to. Includes placeholders for TypeScript and Python SDKs.

In this section

A quick index of available SDKs and where to find their docs.

SDK Status Docs
.NET (C#) Available /sdk/dotnet/
TypeScript Coming Soon /sdk/javascript/
Python Coming Soon /sdk/python/

Placeholders

TypeScript and Python entries are placeholders for now. We will update links and status as the documentation for those SDKs are published.

Quick start chooser

Pick the SDK that matches your stack. Each quick start gets you from authentication to your first results.

  • .NET (C#)
    • Install (replace with the published package name): 
      dotnet add package AIForged.SDK
    • Authenticate, upload a document, trigger processing, retrieve results.
    • Explore how‑to guides for documents, datasets, HITL, and errors/retries.
    • Links:
  • TypeScript
    • Install (placeholder; replace with the published package name): 
      npm install AIForged.SDK
    • Placeholder for install, auth, and first document flow.
    • Links:
  • Python
    • Install (placeholder; replace with the published package name): 
      pip install AIForged.SDK
    • Placeholder for install, auth, and first document flow.
    • Links:

Fast path to success

Start with a tiny sample (one or two documents) to validate your flow end‑to‑end. Scale only after you’ve confirmed outputs and any HITL (Human‑in‑the‑Loop) steps.

Typical developer flow

A small visual to orient new developers to the common steps you’ll implement with any SDK.

flowchart LR
  A["Authentication"] --> B["Upload Documents"]
  B["Upload Documents"] --> C["Process"]
  C["Process"] --> D["Retrieve Results"]
  D["Retrieve Results"] --> E["Optional: HITL (Work Items)"]
  D --> F["Optional: Custom Datasets"]
  E --> G["Export / Integrate"]
  F --> G["Export / Integrate"]
  A --> H["Errors & Retries"]
  B --> H
  C --> H
  D --> H
  E --> H
  F --> H

Where to go next

Integrations and automation

AIForged integrates with RPA and low‑code tools for orchestration at scale.

  • UiPath activities: build unattended and attended automations with AIForged steps.
  • Power Automate connector: trigger AIForged actions and react to results within flows.
  • Webhooks: subscribe your services to document, verification, or workflow events.

When to use integrations

Use SDKs for application code and deeper control. Use UiPath or Power Automate to compose cross‑system workflows and human approvals without writing much code.

Best practices

  • Choose the SDK closest to your runtime and team skills.
  • Capture External IDs at ingest for easy reconciliation downstream.
  • Prefer server‑side filtering, paging, and sorting for performance and cost.
  • Define clear HITL criteria early (confidence thresholds, sensitive fields).
  • Implement retries only for transient conditions; avoid retrying on most 4xx responses.

Security essentials

Never commit tokens or secrets. Use environment variables or secret managers. Scope tokens minimally and rotate regularly.

Troubleshooting

  • Can’t authenticate
    • Verify base URL and token configuration; try a minimal “who‑am‑I” or read call.
  • No results after processing
    • Check document status transitions and service configuration; loosen filters.
  • Unexpected HITL routing
    • Confirm assignment method, target group/user, and role flags.

Deeper help

Each SDK section includes targeted troubleshooting for its quick starts and how‑tos.