SDKs

Install official AILabTools SDKs or use direct HTTP to integrate AILabTools image APIs.

Prerequisites

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

Integration Options

Integration	Guidance
AILabTools Multi-language SDKs	Use an official SDK for supported runtimes.
AILabTools PHP SDK	Use the Composer package for PHP applications.
Direct HTTP	Call the API endpoints directly from your own HTTP client.

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.

Install

Select your runtime, then use the package manager already used by your project.

Unversioned commands install the latest published release. Versioned snippets are pinning examples; check the linked registry before copying a fixed version into production.

Node.js

Requires Node.js 18 or later.

The package is published on npm. npm, pnpm, Yarn, and Bun install the same ailabtools package.

npm: ailabtools

npm install ailabtools

pnpm: ailabtools

pnpm add ailabtools

Yarn: ailabtools

yarn add ailabtools

Bun: ailabtools

bun add ailabtools

bun add only covers dependency installation. Validate your application before using Bun as the production runtime for the Node.js SDK.

Python

Requires Python 3.8 or later. Install ailabtools-sdk, then import it as ailabtools.

Use pip or uv pip for environment-level installs. Use uv add or poetry add for project dependencies.

pip: ailabtools-sdk

pip install ailabtools-sdk

uv environment: ailabtools-sdk

uv pip install ailabtools-sdk

uv project: ailabtools-sdk

uv add ailabtools-sdk

Poetry: ailabtools-sdk

poetry add ailabtools-sdk

Go

Use the module path shown on pkg.go.dev for the current Go package and exported type names.

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

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

Dart / Flutter

Requires Dart SDK >=3.0.0 <4.0.0. This is a pure Dart package. Use flutter pub for Flutter apps or dart pub for Dart packages and CLIs.

Flutter: ailabtools

flutter pub add ailabtools

Dart: ailabtools

dart pub add ailabtools

PHP

Requires PHP 8.1 or later and Composer.

Composer: ailabtools/ailabtools

composer require ailabtools/ailabtools

Or add the package to composer.json:

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

Ruby

Requires Ruby 2.6 or later. Use Bundler for applications, or RubyGems for direct installation.

Bundler: ailabtools

gem "ailabtools", "~> 0.5.4"

RubyGems: ailabtools

gem install ailabtools

Rust

Requires Rust 1.70 or later. Use Cargo to add the crate to your project.

Cargo: ailabtools

cargo add ailabtools

Or add the crate to Cargo.toml:

[dependencies]
ailabtools = "0.5.4"

Java

Requires Java 11 or later. Choose Maven or Gradle according to your build system.

Maven: com.ailabtools:ailabtools-sdk

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

Gradle: com.ailabtools:ailabtools-sdk

Groovy DSL:

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

Kotlin DSL:

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

Swift

Requires iOS 13.0, macOS 10.15, tvOS 13.0, or watchOS 6.0 or later. Use Swift Package Manager or CocoaPods according to your Apple platform project setup.

Swift Package Manager: ailabtools/ailabtools-sdk

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

CocoaPods: AILabTools

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 the support team locate failed requests.

Related Resources

• Get API Key
• OpenAPI JSON
• Response Description
• File Storage Policy
• Billing Introduction