Official SDKs - AILabTools API Docs

Prerequisites

Create an API key in the Developer Console.
Store the key in an environment variable or secret manager.
Choose either an SDK integration or direct HTTP integration.

Integration Options

Option	Best for	Start here
Official SDK	Supported runtimes that benefit from typed clients, file helpers, SDK method names, and async polling helpers.	Install the package below, then open the SDK API index.
Direct HTTP	Unsupported runtimes, custom HTTP clients, or integrations that need full request control.	Open the API reference page for the endpoint, such as Universal Background Removal.

SDKs wrap the same public HTTP APIs documented on this site. Direct HTTP and SDK integrations use the same API key and the same underlying endpoints.

SDK methods may use language-native field names. The API reference remains the source of truth for field meaning, valid values, billing, and response structure.

Available SDKs

Installable SDK packages and documentation links:

Only published SDKs are listed. For other languages or runtimes, use the direct HTTP API.

Platform	Package	Notes	Docs
Node.js / TypeScript	npm: `ailabtools`	Requires Node.js 18 or later.	Examples · SDK README
Python (async)	PyPI: `ailabtools-sdk`	Requires Python 3.8 or later. Import as `ailabtools`.	Examples · SDK README
Go	pkg.go.dev: `github.com/ailabtools/ailabtools-sdk/packages/go`	Use package docs for Go type names.	Examples · Package docs
Dart / Flutter	pub.dev: `ailabtools`	Pure Dart package. Use `dart pub` or `flutter pub`.	Examples · SDK README
PHP	Packagist: `ailabtools/ailabtools`	Requires PHP 8.1 or later and Composer.	Examples · SDK README
Ruby	RubyGems: `ailabtools`	Requires Ruby 2.6 or later.	Examples · SDK README
Rust	crates.io: `ailabtools`	Requires Rust 1.70 or later.	Examples · SDK README
Java	Maven Central: `com.ailabtools:ailabtools-sdk`	Requires Java 11 or later.	Examples · SDK README
Swift	Swift Package Manager / CocoaPods: `AILabTools`	Use SwiftPM or CocoaPods.	Examples · SDK README

Install

Choose the package manager used by your project.

Multiple commands in the same tab install the same SDK package. They are package-manager alternatives, not separate SDKs.

Unversioned commands install the latest release available at install time. Versioned snippets show a verified release; check the linked registry page before pinning or upgrading in production.

The SDK runtime requirement is Node.js 18 or later.

bun add is listed as a package installation command. Test separately before treating the Bun runtime itself as a supported production runtime.

npm

npm install ailabtools

pnpm

pnpm add ailabtools

Yarn

yarn add ailabtools

Bun

bun add ailabtools

Use environment-level or project-level commands according to how your Python project is managed.

pip

pip install ailabtools-sdk

uv environment

uv pip install ailabtools-sdk

uv project

uv add ailabtools-sdk

Poetry

poetry add ailabtools-sdk

The PyPI package name is ailabtools-sdk, while the Python import package name is ailabtools.

go get github.com/ailabtools/ailabtools-sdk/packages/go

Flutter

flutter pub add ailabtools

Dart

dart pub add ailabtools

Composer

composer require ailabtools/ailabtools

Or add the package to composer.json:

{
  "require": {
    "ailabtools/ailabtools": "^0.5.4"
  }
}

RubyGems

gem install ailabtools

Bundler

gem "ailabtools", "~> 0.5.4"

Cargo

cargo add ailabtools

Or add the crate to Cargo.toml:

[dependencies]
ailabtools = "0.5.4"

Use the latest version shown on Maven Central. Maven and Gradle both consume the same artifact.

Maven

<dependency>
  <groupId>com.ailabtools</groupId>
  <artifactId>ailabtools-sdk</artifactId>
  <version>0.5.4</version>
</dependency>

Gradle

Groovy DSL:

implementation "com.ailabtools:ailabtools-sdk:0.5.4"

Kotlin DSL:

implementation("com.ailabtools:ailabtools-sdk:0.5.4")

Use the latest Git tag for Swift Package Manager or the latest version shown on CocoaPods.Swift Package Manager:

.package(
  url: "https://github.com/ailabtools/ailabtools-sdk.git",
  from: "0.5.4"
)

CocoaPods:

pod 'AILabTools', '~> 0.5.4'

Authentication

All SDKs authenticate with an AILabTools API key. SDK examples use AILAB_API_KEY as the environment variable name:

export AILAB_API_KEY="your_api_key_here"

Pass this value to the SDK client in your application code.

AILAB_API_KEY is an SDK example convention, not an HTTP header name. Direct HTTP calls use the ailabapi-api-key request header shown in each API reference page.

For public browser, desktop, or mobile applications, do not ship your AILabTools API key with the client. Call AILabTools from your backend, or issue requests through a trusted service that keeps the API key private.

Implementation Notes

Topic	Guidance
Request fields	SDKs may expose language-native names, such as `returnForm` for the HTTP field `return_form`. Use the SDK docs for code and the API reference for field meaning.
File uploads	Use SDK-supported file helpers such as file paths, bytes, buffers, streams, or language-specific file wrappers.
Async tasks	If a response contains `task_id`, use the SDK polling helper where available or call Querying Async Task Results.
Result URLs	Result image URLs may be temporary. Download and store files promptly if your application needs long-term access.
Errors	Log `request_id` and `log_id` when handling API errors. These IDs help support locate failed requests.

​Prerequisites

​Integration Options

​Available SDKs

​Install

​npm

​pnpm

​Yarn

​Bun

​pip

​uv environment

​uv project

​Poetry

​Flutter

​Dart

​Composer

​RubyGems

​Bundler

​Cargo

​Maven

​Gradle

​Authentication

​Implementation Notes

​Related Resources

Prerequisites

Integration Options

Available SDKs

Install

npm

pnpm

Yarn

Bun

pip

uv environment

uv project

Poetry

Flutter

Dart

Composer

RubyGems

Bundler

Cargo

Maven

Gradle

Authentication

Implementation Notes

Related Resources