API reference

https://api.bitmesh.ai

• POST /chat Create a completion
• POST /image Generate an image
• GET /imgrslt/{object_id} View an image
• POST /video Generate a video
• GET /video/{id} Retrieve a video
• GET /imgrslt/{object_id} View a video
• POST /transcribe-recorded Create a transcription
• GET /transcribe-recorded/{id} Retrieve a transcription
• POST /tools/general/background-removal Remove a background
• POST /tools/portrait/try-on-clothes Try on clothes
• POST /tools/query-async-task-result Retrieve a tool task
• POST /tools/video/image-animate Animate an image
• GET /tools/video/image-animate/{task_id} Retrieve an animation
• GET /balance Balance

composer config repositories.bitmesh vcs https://github.com/bitmeshai/bitmesh-php-sdk
composer require bitmeshai/bitmesh-php-sdk:^2.1

pip install "git+https://github.com/bitmeshai/bitmesh-python-sdk.git"

// Package.swift, or File > Add Package Dependencies in Xcode
.package(url: "https://github.com/bitmeshai/bitmesh-ios-sdk.git", from: "1.0.0")

# pubspec.yaml
dependencies:
  bitmesh_flutter_sdk:
    git:
      url: https://github.com/bitmeshai/bitmesh-flutter-sdk.git
      ref: v0.3.0

use BitmeshAI\BitmeshClient;

// Optional third argument: timeout in seconds (default 30)
$client = new BitmeshClient('YOUR_CONSUMER_KEY', 'YOUR_CONSUMER_SECRET');

$response = $client->chat([
    'model' => 'qwen/qwen3.5-9b',
    'messages' => [
        ['role' => 'user', 'content' => 'Suggest three names for a hiking app.'],
    ],
]);

echo $response['choices'][0]['message']['content'];

import os
from bitmesh_ai import BitmeshClient

# Optional third argument: timeout_seconds (default 30)
client = BitmeshClient(
    os.environ["BITMESH_CONSUMER_KEY"],
    os.environ["BITMESH_CONSUMER_SECRET"],
)

response = client.chat({
    "model": "qwen/qwen3.5-9b",
    "messages": [
        {"role": "user", "content": "Suggest three names for a hiking app."}
    ],
})

print(response["choices"][0]["message"]["content"])

import Bitmesh

let client = BitmeshClient(key: consumerKey, secret: consumerSecret)

let text = try await client.chatContent(
    "Suggest three names for a hiking app.",
    model: "qwen/qwen3.5-9b"
)

import 'package:bitmesh_flutter_sdk/bitmesh_flutter_sdk.dart';

// Create one client and reuse it
final client = BitmeshClient.fromKeys(consumerKey, consumerSecret);

final completion = await client.chat.create(const ChatRequest(
  model: 'qwen/qwen3.5-9b',
  messages: [
    ChatMessage.user('Suggest three names for a hiking app.'),
  ],
));

print(completion.text);

Authorization: OAuth oauth_consumer_key="YOUR_CONSUMER_KEY",
    oauth_signature_method="HMAC-SHA1",
    oauth_timestamp="1766991207",
    oauth_nonce="b2362ab1f26de6ea",
    oauth_version="1.0",
    oauth_signature="1Dk9QHMOfVpSJMUmRJjOcwqanSI%3D"
X-Payload-Signature: 09898af05784a4eb7d3a68323f0d56bea18598a71f4317c535297cdf7325b867
Content-Type: application/json
Accept: application/json

$consumerKey = 'YOUR_CONSUMER_KEY';
$consumerSecret = 'YOUR_CONSUMER_SECRET';
$method = 'POST';
$url = 'https://api.bitmesh.ai/chat';

$body = json_encode([
    'model' => 'qwen/qwen3.5-9b',
    'messages' => [['role' => 'user', 'content' => 'Hello']],
]);

// 1. OAuth parameters
$oauth = [
    'oauth_consumer_key' => $consumerKey,
    'oauth_signature_method' => 'HMAC-SHA1',
    'oauth_timestamp' => (string) time(),
    'oauth_nonce' => bin2hex(random_bytes(16)),
    'oauth_version' => '1.0',
];

// 2. Sort, encode and join them (add query parameters here too)
ksort($oauth);
$pairs = [];
foreach ($oauth as $name => $value) {
    $pairs[] = rawurlencode($name).'='.rawurlencode($value);
}

// 3. Base string: METHOD & URL & PARAMETERS
$base = rawurlencode($method).'&'.rawurlencode($url).'&'.rawurlencode(implode('&', $pairs));

// 4. HMAC-SHA1 with "secret&" as the key
$oauth['oauth_signature'] = base64_encode(
    hash_hmac('sha1', $base, rawurlencode($consumerSecret).'&', true)
);

// 5. Authorization header
$parts = [];
foreach ($oauth as $name => $value) {
    $parts[] = $name.'="'.rawurlencode($value).'"';
}
$authorization = 'OAuth '.implode(', ', $parts);

// 6. Payload signature: body + consumer key + oauth signature
$payloadSignature = hash('sha256', $body.$consumerKey.$oauth['oauth_signature']);

$ch = curl_init($url);
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: '.$authorization,
        'X-Payload-Signature: '.$payloadSignature,
        'Content-Type: application/json',
        'Accept: application/json',
    ],
]);
$response = json_decode(curl_exec($ch), true);

// pubspec.yaml: firebase_core, firebase_app_check
import 'package:firebase_app_check/firebase_app_check.dart';
import 'package:firebase_core/firebase_core.dart';
import 'package:flutter/material.dart';

Future<void> main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Firebase.initializeApp();

  // Debug provider in debug builds ONLY. Never in a release.
  await FirebaseAppCheck.instance.activate(
    providerAndroid: kDebugMode
        ? AndroidDebugProvider()
        : AndroidPlayIntegrityProvider(),
    providerApple: kDebugMode
        ? AppleDebugProvider()
        : AppleAppAttestProvider(),
  );

  runApp(const MyApp());
}

import FirebaseAppCheck
import FirebaseCore

class AppAttestFactory: NSObject, AppCheckProviderFactory {
    func createProvider(with app: FirebaseApp) -> AppCheckProvider? {
        AppAttestProvider(app: app)
    }
}

// Set the factory BEFORE FirebaseApp.configure().
// Debug provider in debug builds ONLY. Never in a release.
#if DEBUG
AppCheck.setAppCheckProviderFactory(AppCheckDebugProviderFactory())
#else
AppCheck.setAppCheckProviderFactory(AppAttestFactory())
#endif
FirebaseApp.configure()

import 'package:bitmesh_flutter_sdk/bitmesh_flutter_sdk.dart';
import 'package:firebase_app_check/firebase_app_check.dart';

// Called before every request, retries and polling included.
// Firebase caches the token and refreshes it before it expires.
final client = BitmeshClient.fromKeys(
  consumerKey,
  consumerSecret,
  options: BitmeshOptions(
    appCheckTokenProvider: () =>
        FirebaseAppCheck.instance.getToken(),
  ),
);

// The Swift SDK can't add headers yet. Sign the request
// yourself (see Authentication), then:
let token = try await AppCheck.appCheck()
    .token(forcingRefresh: false).token

request.setValue(token, forHTTPHeaderField: "X-Firebase-AppCheck")

POST /chat
Authorization: OAuth oauth_consumer_key="YOUR_MOBILE_KEY", ...
X-Payload-Signature: 09898af05784a4eb7d3a6832...
X-Firebase-AppCheck: eyJraWQiOiJ2Yy1sQkEiLCJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9...
Content-Type: application/json

{
  "error": "Missing X-Firebase-AppCheck header"
}

composer config repositories.bitmesh vcs https://github.com/bitmeshai/bitmesh-php-sdk
composer require bitmeshai/bitmesh-php-sdk:^2.1

pip install "git+https://github.com/bitmeshai/bitmesh-python-sdk.git"

// Package.swift, or File > Add Package Dependencies in Xcode
.package(url: "https://github.com/bitmeshai/bitmesh-ios-sdk.git", from: "1.0.0")

# pubspec.yaml
dependencies:
  bitmesh_flutter_sdk:
    git:
      url: https://github.com/bitmeshai/bitmesh-flutter-sdk.git
      ref: v0.3.0

use BitmeshAI\BitmeshClient;

// Optional third argument: timeout in seconds (default 30)
$client = new BitmeshClient('YOUR_CONSUMER_KEY', 'YOUR_CONSUMER_SECRET');

import os
from bitmesh_ai import BitmeshClient

# Optional third argument: timeout_seconds (default 30)
client = BitmeshClient(
    os.environ["BITMESH_CONSUMER_KEY"],
    os.environ["BITMESH_CONSUMER_SECRET"],
)

import Bitmesh

let client = BitmeshClient(key: consumerKey, secret: consumerSecret)

import 'package:bitmesh_flutter_sdk/bitmesh_flutter_sdk.dart';

// Create one client and reuse it
final client = BitmeshClient.fromKeys(consumerKey, consumerSecret);

{
  "error": "Invalid signature"
}

{
  "error": "Validation failed",
  "errors": {
    "messages": ["The messages field is required."]
  }
}

{
  "error": "Insufficient balance",
  "message": "Your have ran out of tokens. Please add tokens to continue.",
  "balance": 0
}

{
  "error": "Too many chat requests",
  "message": "You have exceeded the chat rate limit. Please wait before sending more requests.",
  "retry_after": 42
}

{
  "error": "Request limit exceeded",
  "message": "You have exceeded your request limit for this Api Key. Please contact support or upgrade your plan.",
  "request_usage": 5000,
  "request_limit": 5000
}

{
  "model": "qwen/qwen3.5-9b",
  "messages": [
    {"role": "user", "content": "Hello"}
  ],
  "test": true
}

$response = $client->chat([
    'model' => 'qwen/qwen3.5-9b',
    'messages' => [
        ['role' => 'system', 'content' => 'You are a helpful assistant.'],
        ['role' => 'user', 'content' => 'What are some fun things to do with AI?'],
    ],
    'max_tokens' => 1000,
]);

$text = $response['choices'][0]['message']['content'] ?? null;

response = client.chat({
    "model": "qwen/qwen3.5-9b",
    "messages": [
        {"role": "system", "content": "You are a helpful assistant."},
        {"role": "user", "content": "What are some fun things to do with AI?"},
    ],
    "max_tokens": 1000,
})

text = response["choices"][0]["message"]["content"]

let response = try await client.chat(payload: [
    "model": "qwen/qwen3.5-9b",
    "messages": [
        ["role": "system", "content": "You are a helpful assistant."],
        ["role": "user", "content": "What are some fun things to do with AI?"],
    ],
    "max_tokens": 1000,
])

let choices = response["choices"] as? [[String: Any]]
let message = choices?.first?["message"] as? [String: Any]
let text = message?["content"] as? String

final completion = await client.chat.create(const ChatRequest(
  model: 'qwen/qwen3.5-9b',
  messages: [
    ChatMessage.system('You are a helpful assistant.'),
    ChatMessage.user('What are some fun things to do with AI?'),
  ],
  maxTokens: 1000,
));

final text = completion.text;

{
  "model": "qwen/qwen3.5-9b",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "What are some fun things to do with AI?"}
  ],
  "max_tokens": 1000,
  "temperature": 0.8
}

{
  "id": "oR7yAhG-57nCBj-9b576165af92311c",
  "object": "chat.completion",
  "created": 1766991277,
  "model": "qwen/qwen3.5-9b",
  "choices": [
    {
      "index": 0,
      "finish_reason": "stop",
      "message": {
        "role": "assistant",
        "content": "There are plenty. You could build a chatbot, generate images from a description, or have a model draft a story with you...",
        "tool_calls": []
      }
    }
  ],
  "usage": {
    "prompt_tokens": 51,
    "completion_tokens": 390,
    "total_tokens": 441,
    "cached_tokens": 0
  }
}

{
  "model": "qwen/qwen3.5-9b",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "What are some fun things to do in New York?"},
    {"role": "assistant", "content": "You could visit the Empire State Building, walk through Central Park, or explore the Metropolitan Museum of Art!"},
    {"role": "user", "content": "That sounds fun! Where is the Empire State Building located?"}
  ]
}

$response = $client->chat([
    'model' => 'qwen/qwen3.5-9b',
    'messages' => [
        [
            'role' => 'user',
            'content' => [
                ['type' => 'text', 'text' => 'Describe this image'],
                [
                    'type' => 'image_url',
                    'image_url' => ['url' => 'https://placecats.com/800/600'],
                ],
            ],
        ],
    ],
    'max_tokens' => 1000,
]);

response = client.chat({
    "model": "qwen/qwen3.5-9b",
    "messages": [
        {
            "role": "user",
            "content": [
                {"type": "text", "text": "Describe this image"},
                {"type": "image_url", "image_url": {"url": "https://placecats.com/800/600"}},
            ],
        }
    ],
    "max_tokens": 1000,
})

let content: [[String: Any]] = [
    ["type": "text", "text": "Describe this image"],
    ["type": "image_url", "image_url": ["url": "https://placecats.com/800/600"]],
]
let message: [String: Any] = ["role": "user", "content": content]

let response = try await client.chat(payload: [
    "model": "qwen/qwen3.5-9b",
    "messages": [message],
    "max_tokens": 1000,
])

{
  "model": "qwen/qwen3.5-9b",
  "messages": [
    {
      "role": "user",
      "content": [
        {"type": "text", "text": "Describe this image"},
        {"type": "image_url", "image_url": {"url": "https://placecats.com/800/600"}}
      ]
    }
  ],
  "max_tokens": 1000
}

$response = $client->image([
    'prompt' => 'Flying car',
    'model' => 'google/gemini-3-pro-image',
    'width' => 1024,
    'height' => 1024,
]);

$url = $response['data'][0]['url'] ?? null;

response = client.image({
    "prompt": "Flying car",
    "model": "google/gemini-3-pro-image",
    "width": 1024,
    "height": 1024,
})

url = response["data"][0]["url"]

let response = try await client.image(payload: [
    "prompt": "Flying car",
    "model": "google/gemini-3-pro-image",
    "width": 1024,
    "height": 1024,
])

final result = await client.images.generate(const ImageRequest(
  prompt: 'Flying car',
  model: 'google/gemini-3-pro-image',
  width: 1024,
  height: 1024,
));

final url = result.first?.resolveUrl(client.options.baseUrl);

{
  "prompt": "Flying car",
  "model": "google/gemini-3-pro-image",
  "width": 1024,
  "height": 1024,
  "seed": 22
}

{
  "id": "b26aec3d-aws_as1",
  "model": "google/gemini-3-pro-image",
  "object": "list",
  "data": [
    {
      "index": 0,
      "url": "https://api.together.ai/imgproxy/eZnJQhev9e83egwFF4tDKsJTQTcw5SACdmI7z5C9NEY/format:jpeg/aHR0cHM6Ly9pbS5ydW53YXJlLmFpL2ltYWdlL29zL3cwNGRsaW0zL3dzLzMvaWkvY2ZlZDYxZWMtZjNiNy00ZmRmLWI5MDgtNmJkMzNmZjU5NWVkLmpwZw",
      "timings": {
        "inference": 16617
      }
    }
  ]
}

$response = $client->image([
    'prompt' => 'Make this cat smile',
    'model' => 'wan-ai/wan2.6-image',
    'reference_images' => [
        'https://placecats.com/800/600',
    ],
]);

$url = $response['data'][0]['url'] ?? null;

response = client.image({
    "prompt": "Make this cat smile",
    "model": "wan-ai/wan2.6-image",
    "reference_images": [
        "https://placecats.com/800/600",
    ],
})

let response = try await client.image(payload: [
    "prompt": "Make this cat smile",
    "model": "wan-ai/wan2.6-image",
    "reference_images": [
        "https://placecats.com/800/600",
    ],
])

{
  "prompt": "Make this cat smile",
  "model": "wan-ai/wan2.6-image",
  "reference_images": [
    "https://placecats.com/800/600"
  ]
}

{
  "prompt": "A mountain landscape at sunset with golden light reflecting on a calm lake",
  "model": "black-forest-labs/FLUX.2-pro",
  "width": 1024,
  "height": 768
}

{
  "prompt": "A modern workspace with a laptop, coffee cup, and plants, natural lighting",
  "model": "black-forest-labs/FLUX.2-dev",
  "width": 1024,
  "height": 768,
  "steps": 20
}

{
  "prompt": "Replace the color of the mug to green",
  "model": "black-forest-labs/FLUX.2-pro",
  "width": 1024,
  "height": 768,
  "reference_images": [
    "https://www.bitmesh.ai/images/doc-examples/laptop_flux2-dev.jpeg"
  ]
}

GET https://api.bitmesh.ai/imgrslt/Il4vHBVFuu8tiaXP

<img src="https://api.together.ai/imgproxy/eZnJQhev9e83egwFF4tDKsJTQTcw5SACdmI7z5C9NEY/format:jpeg/aHR0cHM6Ly9pbS5ydW53YXJlLmFpL2ltYWdlL29zL3cwNGRsaW0zL3dzLzMvaWkvY2ZlZDYxZWMtZjNiNy00ZmRmLWI5MDgtNmJkMzNmZjU5NWVkLmpwZw" alt="Flying car">

$response = $client->video([
    'prompt' => 'Happy happy happy cat',
    'model' => 'vidu/vidu-q3',
]);

$id = $response['id'] ?? null;

response = client.video({
    "prompt": "Happy happy happy cat",
    "model": "vidu/vidu-q3",
})

video_id = response["id"]

let response = try await client.video(payload: [
    "prompt": "Happy happy happy cat",
    "model": "vidu/vidu-q3",
])

final job = await client.video.create(const VideoRequest(
  prompt: 'Happy happy happy cat',
  model: 'vidu/vidu-q3',
));

final id = job.id;

{
  "prompt": "Happy happy happy cat",
  "model": "vidu/vidu-q3"
}

{
  "object": "video",
  "id": "01a19801-4eae-7358-a183-e3b6a388a95c",
  "model": "vidu/vidu-q3",
  "status": "in_progress",
  "created_at": 1793551584,
  "seconds": "5",
  "size": "1280x720"
}

$response = $client->video([
    'prompt' => 'Happy happy happy cat',
    'model' => 'vidu/vidu-q3',
    'frame_images' => [
        [
            'input_image' => 'https://example.com/frame-1.jpg',
            'frame' => 0,
        ],
    ],
]);

response = client.video({
    "prompt": "Happy happy happy cat",
    "model": "vidu/vidu-q3",
    "frame_images": [
        {"input_image": "https://example.com/frame-1.jpg", "frame": 0},
    ],
})

let frame: [String: Any] = ["input_image": "https://example.com/frame-1.jpg", "frame": 0]

let response = try await client.video(payload: [
    "prompt": "Happy happy happy cat",
    "model": "vidu/vidu-q3",
    "frame_images": [frame],
])

{
  "prompt": "Happy happy happy cat",
  "model": "vidu/vidu-q3",
  "frame_images": [
    {"input_image": "https://example.com/frame-1.jpg", "frame": 0}
  ]
}

{
  "prompt": "Happy happy happy cat",
  "model": "vidu/vidu-q1",
  "reference_images": [
    "https://example.com/ref-1.jpg",
    "https://example.com/ref-2.jpg"
  ]
}

$video = $client->getVideo('01a19801-4eae-7358-a183-e3b6a388a95c');

if (($video['status'] ?? null) === 'completed') {
    $url = $video['outputs']['video_url'];
}

video = client.get_video("01a19801-4eae-7358-a183-e3b6a388a95c")

if video.get("status") == "completed":
    url = video["outputs"]["video_url"]

let video = try await client.getVideo(id: "01a19801-4eae-7358-a183-e3b6a388a95c")

if video["status"] as? String == "completed" {
    let outputs = video["outputs"] as? [String: Any]
    let url = outputs?["video_url"] as? String
}

final job = await client.video.get('01a19801-4eae-7358-a183-e3b6a388a95c');

if (job.isCompleted) {
  print(job.videoUrl);
}

// Or let the SDK poll until the job finishes
final finished = await client.video.waitFor(job.id);

GET https://api.bitmesh.ai/video/01a19801-4eae-7358-a183-e3b6a388a95c

{
  "object": "video",
  "id": "01a19801-4eae-7358-a183-e3b6a388a95c",
  "model": "vidu/vidu-q3",
  "status": "completed",
  "created_at": 1793551584,
  "completed_at": 1793551697,
  "seconds": "5",
  "size": "1280x720",
  "outputs": {
    "video_url": "https://api.bitmesh.ai/imgrslt/LMwdUAk0OYxYZRcR"
  }
}

GET https://api.bitmesh.ai/imgrslt/LMwdUAk0OYxYZRcR

<video src="https://api.bitmesh.ai/imgrslt/LMwdUAk0OYxYZRcR" controls></video>

// Allow time for the upload: third argument is the timeout in seconds
$client = new BitmeshClient('YOUR_CONSUMER_KEY', 'YOUR_CONSUMER_SECRET', 600);

$response = $client->transcribeFile('/path/to/recording.mp3', [
    'speech_models' => ['universal-2'],
]);

$transcriptId = $response['id'] ?? null;

# Allow time for the upload
client = BitmeshClient(key, secret, timeout_seconds=600)

response = client.transcribe_file("/path/to/recording.mp3", {
    "speech_models": ["universal-2"],
})

transcript_id = response["id"]

let response = try await client.transcribeFile(
    audioFileURL: URL(fileURLWithPath: "/path/to/recording.mp3"),
    fields: ["speech_models": ["universal-2"]]
)

final job = await client.transcription.createFromPath(
  '/path/to/recording.mp3',
  speechModels: ['universal-2'],
);

final transcriptId = job.id;

{
  "audio_url": "https://example.com/recording.mp3",
  "speech_models": ["universal-2"]
}

// Every form field except the file
$fields = ['speech_models' => ['universal-2']];

ksort($fields);
$body = json_encode($fields, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);

$payloadSignature = hash('sha256', $body.$consumerKey.$oauthSignature);

{
  "id": "019c905a-aaaa-bbbb-cccc-111122223333",
  "status": "queued",
  "text": null
}

$job = $client->getTranscribeRecorded('019c905a-aaaa-bbbb-cccc-111122223333');

if (($job['status'] ?? null) === 'completed') {
    echo $job['text'];
}

job = client.get_transcribe_recorded("019c905a-aaaa-bbbb-cccc-111122223333")

if job.get("status") == "completed":
    print(job["text"])

let job = try await client.getTranscribeRecorded(id: "019c905a-aaaa-bbbb-cccc-111122223333")

if job["status"] as? String == "completed" {
    let text = job["text"] as? String
}

final job = await client.transcription.get('019c905a-aaaa-bbbb-cccc-111122223333');

if (job.isCompleted) {
  print(job.text);
}

// Or let the SDK poll until the job finishes
final finished = await client.transcription.waitFor(job.id);

GET https://api.bitmesh.ai/transcribe-recorded/019c905a-aaaa-bbbb-cccc-111122223333

{
  "id": "019c905a-aaaa-bbbb-cccc-111122223333",
  "status": "completed",
  "text": "Thanks for calling. How can I help you today?",
  "language_code": "en",
  "audio_duration": 12
}

1. POST /tools/portrait/try-on-clothes
   → task_id

2. POST /tools/query-async-task-result
   {"task_id": "…"}
   → status "queued" or "processing"
   wait 10 seconds and ask again

3. → status "success"
   → output.image_url

4. GET output.image_url
   → the finished image (download it within 24 hours)

// Every form field except the files, as strings
$fields = ['restore_face' => '1', 'resolution' => '1024'];

ksort($fields);
$body = $fields === []
    ? '[]'
    : json_encode($fields, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE);
// {"resolution":"1024","restore_face":"1"}

$payloadSignature = hash('sha256', $body.$consumerKey.$oauthSignature);

import hashlib, json

# Every form field except the files, as strings
fields = {"restore_face": "1", "resolution": "1024"}

body = (
    json.dumps(dict(sorted(fields.items())), separators=(",", ":"), ensure_ascii=False)
    if fields else "[]"
)
# {"resolution":"1024","restore_face":"1"}

payload_signature = hashlib.sha256(
    (body + consumer_key + oauth_signature).encode()
).hexdigest()

$result = $client->toolsGeneralBackgroundRemoval(
    ['return_form' => 'crop'],
    '/path/to/photo.jpg'
);

$url = $result['data']['image_url'] ?? null;

// The link expires: keep your own copy
file_put_contents('/path/to/cutout.png', file_get_contents($url));

import urllib.request

result = client.tools_general_background_removal(
    {"return_form": "crop"},
    "/path/to/photo.jpg",
)

url = result["data"]["image_url"]

# The link expires: keep your own copy
urllib.request.urlretrieve(url, "/path/to/cutout.png")

let result = try await client.toolsGeneralBackgroundRemoval(
    fields: ["return_form": "crop"],
    imageFileURL: URL(fileURLWithPath: "/path/to/photo.jpg")
)

let data = result["data"] as? [String: Any]
if let link = data?["image_url"] as? String, let url = URL(string: link) {
    // The link expires: keep your own copy
    let (png, _) = try await URLSession.shared.data(from: url)
}

final result = await client.tools.backgroundRemoval(
  BitmeshFile.fromPath('/path/to/photo.jpg'),
  fields: {'return_form': 'crop'},
);

// The link expires: keep your own copy
final png = await client.tools.fetchResultBytes(result.outputUrl!);

POST https://api.bitmesh.ai/tools/general/background-removal
Content-Type: multipart/form-data

image: (file) photo.jpg
return_form: crop

{
  "data": {
    "image_url": "https://ailab-outputs.oss-accelerate.aliyuncs.com/cutout/commonImage/2026-11-02-01/0fc01abc-48de-8316-229c-d1e74619dfc7_1793552716.png"
  },
  "error_code": 0,
  "request_id": "01A19812-91F5-54D1-B1B9-004FBCB51A65",
  "detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "status": "success"
}

// Allow time for the upload: third argument is the timeout in seconds
$client = new BitmeshClient('YOUR_CONSUMER_KEY', 'YOUR_CONSUMER_SECRET', 120);

$job = $client->toolsPortraitTryOnClothes(
    ['restore_face' => '1', 'resolution' => '1024'],
    [
        'person_image' => '/path/to/person.jpg',
        'top_garment' => '/path/to/shirt.jpg',
    ]
);

$taskId = $job['task_id'] ?? null;

# Allow time for the upload
client = BitmeshClient(key, secret, timeout_seconds=120)

job = client.tools_portrait_try_on_clothes(
    {"restore_face": "1", "resolution": "1024"},
    {
        "person_image": "/path/to/person.jpg",
        "top_garment": "/path/to/shirt.jpg",
    },
)

task_id = job["task_id"]

let job = try await client.toolsPortraitTryOnClothes(
    fields: ["restore_face": "1", "resolution": "1024"],
    files: [
        "person_image": URL(fileURLWithPath: "/path/to/person.jpg"),
        "top_garment": URL(fileURLWithPath: "/path/to/shirt.jpg"),
    ]
)

let taskId = job["task_id"] as? String

final job = await client.tools.tryOnClothes(
  {
    'person_image': BitmeshFile.fromPath('/path/to/person.jpg'),
    'top_garment': BitmeshFile.fromPath('/path/to/shirt.jpg'),
  },
  fields: {'restore_face': '1', 'resolution': '1024'},
);

final taskId = job.taskId;

POST https://api.bitmesh.ai/tools/portrait/try-on-clothes
Content-Type: multipart/form-data

person_image: (file) person.jpg
top_garment: (file) shirt.jpg
restore_face: 1
resolution: 1024

{
  "error_code": 0,
  "request_id": "85200403",
  "task_id": "1793549228989.e65e0fb6-7ff6-dffd-5272-d1b8bf9510a2",
  "task_type": "async",
  "detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "status": "success"
}

do {
    sleep(10);
    $task = $client->toolsQueryAsyncTaskResult($taskId);
} while (in_array($task['status'] ?? null, ['queued', 'processing'], true));

if ($task['status'] === 'success') {
    $url = $task['output']['image_url'];
    file_put_contents('/path/to/result.png', file_get_contents($url));
}

import time, urllib.request

while True:
    time.sleep(10)
    task = client.tools_query_async_task_result(task_id)
    if task.get("status") not in ("queued", "processing"):
        break

if task["status"] == "success":
    url = task["output"]["image_url"]
    urllib.request.urlretrieve(url, "/path/to/result.png")

var task: [String: Any]
repeat {
    try await Task.sleep(nanoseconds: 10_000_000_000)
    task = try await client.toolsQueryAsyncTaskResult(taskId: taskId)
} while ["queued", "processing"].contains(task["status"] as? String)

if task["status"] as? String == "success" {
    let output = task["output"] as? [String: Any]
    let url = output?["image_url"] as? String
}

// Let the SDK poll until the task finishes
final finished = await client.tools.waitFor(
  taskId,
  options: const PollingOptions(interval: Duration(seconds: 10)),
);

final picture = await client.tools.fetchResultBytes(finished.outputUrl!);

{
  "task_id": "1793549228989.e65e0fb6-7ff6-dffd-5272-d1b8bf9510a2"
}

{
  "error_code": 0,
  "output": {
    "image_url": "https://ailab-outputs.oss-accelerate.aliyuncs.com/aiScheduler/image2/edit/2026-11-02-00/956c9756-189b-a6ec-9de3-59c9d162183a_1793549243.png"
  },
  "task_status": 2,
  "detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "status": "success"
}

{
  "error_code": 0,
  "task_status": 1,
  "detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "status": "processing"
}

{
  "error": "task_id is invalid."
}

$job = $client->imageAnimate([
    'model' => 'animate-2.4-faster',
    'image' => [
        'bytes_base64_encoded' => base64_encode(file_get_contents('/path/to/cat.png')),
    ],
    'seconds' => 5,
    'prompt' => 'The cat slowly blinks',
    'aspect_ratio' => '9:16',
]);

$taskId = $job['data']['task_id'];

let image = try Data(contentsOf: URL(fileURLWithPath: "/path/to/cat.png"))

let job = try await client.imageAnimate(payload: [
    "model": "animate-2.4-faster",
    "image": ["bytes_base64_encoded": image.base64EncodedString()],
    "seconds": 5,
    "prompt": "The cat slowly blinks",
    "aspect_ratio": "9:16",
])

let taskId = (job["data"] as? [String: Any])?["task_id"] as? String

// The SDK base64-encodes the image for you
final job = await client.tools.imageAnimate(
  model: 'animate-2.4-faster',
  image: BitmeshFile.fromPath('/path/to/cat.png'),
  seconds: 5,
  prompt: 'The cat slowly blinks',
  aspectRatio: '9:16',
);

final taskId = job.taskId;

{
  "model": "animate-2.4-faster",
  "image": {
    "bytes_base64_encoded": "iVBORw0KGgoAAAANSUhEUgAA…"
  },
  "seconds": 5,
  "prompt": "The cat slowly blinks",
  "aspect_ratio": "9:16"
}

{
  "code": 0,
  "data": {
    "task_id": "06ae763e-0ce0-7475-8000-258b9a39351c"
  }
}

do {
    sleep(5);
    $job = $client->getImageAnimate($taskId);
    $status = $job['data']['status'] ?? null;
} while (! in_array($status, ['SUCCESS', 'FAILED', 'CANCELED'], true));

if ($status === 'SUCCESS') {
    $url = $job['data']['output_videos'][0]['url'];
    file_put_contents('/path/to/cat.mp4', file_get_contents($url));
}

var data: [String: Any] = [:]
repeat {
    try await Task.sleep(nanoseconds: 5_000_000_000)
    let job = try await client.getImageAnimate(taskId: taskId)
    data = job["data"] as? [String: Any] ?? [:]
} while !["SUCCESS", "FAILED", "CANCELED"].contains(data["status"] as? String)

if data["status"] as? String == "SUCCESS" {
    let videos = data["output_videos"] as? [[String: Any]]
    let url = videos?.first?["url"] as? String
}

// Let the SDK poll until the video is ready
final finished = await client.tools.waitForImageAnimate(taskId);

final video = await client.tools.fetchResultBytes(finished.outputUrl!);

GET https://api.bitmesh.ai/tools/video/image-animate/06ae763e-0ce0-7475-8000-258b9a39351c

{
  "code": 0,
  "data": {
    "task_id": "06ae763e-0ce0-7475-8000-258b9a39351c",
    "id": "06ae763e-0ce0-7475-8000-258b9a39351c",
    "status": "SUCCESS",
    "category": "IMAGE_TO_VIDEO",
    "callback_url": "https://api.bitmesh.ai/tools/video/image-animate-callback/17935492801122",
    "seconds": 3,
    "output_videos": [
      {
        "url": "https://assets-cdn.domoai.com/output/video/d0a0c368-264b-4645-8b4e-1801174b994b.mp4?q-sign-algorithm=sha1&…",
        "width": 720,
        "height": 1280
      }
    ],
    "credits": 6,
    "inputs": {
      "model": "animate-2.4-faster",
      "prompt": "The cat slowly blinks",
      "seconds": 3,
      "image_url": "https://assets-cdn.domoai.com/input/image/e05f11d7-3b59-48d2-86c2-d24393bcb215.png?…",
      "aspect_ratio": "9:16"
    },
    "created_at": "2026-11-01T16:08:00.800782"
  }
}

GET https://api.bitmesh.ai/balance

{
  "balance": 42.5
}