Client Configuration

Reference documentation on preparing and configuring the Mindee client.

This is reference documentation.

Code samples shown are only examples, and will not work as-is. You'll need to copy-paste and modify according to your requirements.

Looking full code samples?

You can also use the "Ask" button at the top of any page in the documentation.

Before You Start

You'll need to have one of the official Mindee SDKs installed.

You'll also need to use one of your API keys and have at least one Model configured.

The client works for all model types.

Initialize the Mindee Client

Before sending any files to the Mindee servers for processing, you'll need to initialize your client.

This should be the first step in your code. It will determine which organization is used to make the calls.

You should reuse the same client instance for all calls of the same organization.

The client instance is thread-safe in applicable languages.

First import the needed classes:

from mindee.v2 import Client

For the API key, you can pass it directly to the client. This is useful for quick testing.

api_key = "MY_API_KEY"

mindee_client = Client(api_key)

Instead of passing the key directly, you can also set the following environment variable:

MINDEE_V2_API_KEY

This is recommended for production use. In this way there is no need to pass the api_key when initializing the client.

mindee_client = Client()

First import the needed classes. We recommend using ES Modules.

import * as mindee from "mindee";
// If you're on CommonJS:
// const mindee = require("mindee");

For the API key, you can pass it directly to the client. This is useful for quick testing.

const apiKey = "MY_API_KEY";

const mindeeClient = new mindee.Client({ apiKey: apiKey });

Instead of passing the key directly, you can also set the following environment variable:

MINDEE_V2_API_KEY

This is recommended for production use. In this way there is no need to pass the apiKey argument when initializing the client.

const mindeeClient = new mindee.Client();

Advanced Usage

internally, undici is used for making HTTP calls, and when the client is initialized getGlobalDispatcher is called.

This is perfectly fine for the vast majority of cases: If you set a custom Agent as your global dispatcher, Mindee will use it for all calls.

In some rare cases you may need a specific dispatcher for Mindee, different from your global dispatcher. You can set a custom dispatcher as follows:

import { Agent, interceptors } from "undici";

// Init the custom Dispatcher
// REPLACE THE LINE BELOW WITH YOUR CODE - this example will NOT work!
const myDispatcher = new Agent().compose( ... );

const mindeeClient = new mindee.Client({
  // Don't set if using an environment variable
  apiKey: apiKey,

  // Activates verbose logging - disable in production!
  debug: true,

  // Pass the custom dispatcher to the Mindee client
  dispatcher: myDispatcher,
});

The Mindee client will then use the given dispatcher for all calls.

This is the recommended setup when needing to pass extra parameters or configuration options, for example when using the Client behind a proxy.

When running in some serverless environments like Vercel, sometimes (this depends on your exact setup) there are errors caused by freezing/thawing of the process. These can be avoided by:

// Avoids stale connections accumulating in the pool.
const myDispatcher = new Agent({
  // Drop idle sockets after 1 ms, effectively disables connection reuse
  keepAliveTimeout: 1,
  // Prevent the server from extending the window via a Keep-Alive header
  keepAliveMaxTimeout: 1,
});

First import the needed classes:

use Mindee\V2\Client;

For the API key, you can pass it directly to the client. This is useful for quick testing.

$apiKey = "MY_API_KEY";

$mindeeClient = new Client($apiKey);

Instead of passing the key directly, you can also set the following environment variable:

MINDEE_V2_API_KEY

This is recommended for production use. In this way there is no need to pass the $apiKey when initializing the client.

$mindeeClient = new Client($apiKey);

First import the Mindee package:

require 'mindee'

For the API key, you can pass it directly to the client. This is useful for quick testing.

api_key = 'MY_API_KEY'
mindee_client = Mindee::V2::Client.new(api_key: api_key)

Instead of passing the key directly, you can also set the following environment variable:

MINDEE_V2_API_KEY

This is recommended for production use. In this way there is no need to pass the api_key when initializing the client.

mindee_client = Mindee::V2::Client.new()

First import the needed classes:

import com.mindee.v2.MindeeClient;

For the API key, you can pass it directly to the client. This is useful for quick testing.

String apiKey = "MY_API_KEY";

MindeeClient mindeeClient = new MindeeClient(apiKey);

Instead of passing the key directly, you can also set the following environment variable:

MINDEE_V2_API_KEY

This is recommended for production use. In this way there is no need to pass the apiKey argument when initializing the client.

MindeeClient mindeeClient = new MindeeClient();

First add the required namespaces.

using Mindee.V2;

For the API key, you can pass it directly to the client. This is useful for quick testing.

string apiKey = "MY_API_KEY";

Client mindeeClient = new Client(apiKey);

Instead of passing the key directly, you can also set the following environment variable:

MindeeV2__ApiKey

This is recommended for production use. In this way there is no need to pass the apiKey argument when initializing the client.

Client mindeeClient = new Client();

PreviousCommand Line Tools (CLI)NextBasic Model Configuration

Last updated 13 days ago

Was this helpful?