> ## Documentation Index
> Fetch the complete documentation index at: https://algolia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent Studio API client

> Build generative AI experiences with your Algolia data using the Agent Studio API client.

<Callout icon="flask-conical" color="#14b8a6">
  This is a **beta feature** according to [Algolia's Terms of Service ("Beta Services")](https://www.algolia.com/policies/terms/).
</Callout>

<Tabs>
  <Tab title="C#">
    The Agent Studio API client is part of the `Algolia.Search` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    dotnet add package Algolia.Search
    ```

    To use the Agent Studio client, import these namespaces:

    ```cs C# icon=code theme={"system"}
    using Algolia.Search.Clients;
    using Algolia.Search.Http;
    using Algolia.Search.Models.AgentStudio;
    ```

    To create an instance of the client:

    ```cs C# icon=code theme={"system"}
    var client = new AgentStudioClient(
      new AgentStudioConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
    );
    ```
  </Tab>

  <Tab title="Dart">
    The Agent Studio API client is part of the `algoliasearch` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    dart pub add algoliasearch
    ```

    To use the Agent Studio API client, add this import to your files:

    ```dart Dart icon=code theme={"system"}
    import 'package:algolia_client_agent_studio/algolia_client_agent_studio.dart';
    ```

    To create an instance of the client:

    ```dart Dart icon=code theme={"system"}
    final client = AgentStudioClient(
      appId: 'ALGOLIA_APPLICATION_ID',
      apiKey: 'ALGOLIA_API_KEY'
    );
    ```
  </Tab>

  <Tab title="Go">
    The Agent Studio API client is part of the `algoliasearch-client-go` package.
    To install it, run:

    ```sh Command line icon=square-terminal theme={"system"}
    go get github.com/algolia/algoliasearch-client-go
    ```

    To use the Agent Studio client, add this import to your files:

    ```go Go icon=code theme={"system"}
    import agentStudio "github.com/algolia/algoliasearch-client-go/v4/algolia/agent-studio"
    ```

    To create an instance of the client:

    ```go Go icon=code theme={"system"}
    client, err := agentStudio.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
    if err != nil {
      // The client can fail to initialize if you pass an invalid parameter.
      panic(err)
    }
    ```
  </Tab>

  <Tab title="Java">
    The Agent Studio API client is part of the `algoliasearch` package.
    You can add this package to your `pom.xml` file for **Maven**:

    ```xml pom.xml icon=code-xml theme={"system"}
    <dependency>
      <groupId>com.algolia</groupId>
      <artifactId>algoliasearch</artifactId>
      <version>4.25.0</version>
    </dependency>
    ```

    or to your `build.gradle` file for **Gradle**:

    ```groovy build.gradle icon=braces theme={"system"}
    implementation 'com.algolia:algoliasearch:4.25.0'
    ```

    To use the Agent Studio client, add these imports to your files:

    ```java Java icon=code theme={"system"}
    import com.algolia.api.AgentStudioClient;
    import com.algolia.config.*;
    ```

    To create an instance of the client:

    ```java Java icon=code theme={"system"}
    AgentStudioClient client = new AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
    ```
  </Tab>

  <Tab title="JavaScript">
    The Agent Studio API client is part of the `@algolia/agent-studio` package.
    To install it, run:

    ```sh Command line icon=square-terminal theme={"system"}
    npm install @algolia/agent-studio
    ```

    To use this client, run:

    ```js JavaScript icon=code theme={"system"}
    import { agentStudioClient } from "@algolia/agent-studio";

    const client = agentStudioClient(
      "ALGOLIA_APPLICATION_ID",
      "ALGOLIA_API_KEY",
    );
    ```
  </Tab>

  <Tab title="Kotlin">
    The Agent Studio API client is part of the `algoliasearch-client-kotlin` package.
    You can add this package to your `build.gradle.kts` file:

    ```kt build.gradle.kts icon=braces theme={"system"}
    implementation("com.algolia:algoliasearch-client-kotlin:3.28.0")
    // You also need to add a KTOR engine as dependency, for example:
    implementation("io.ktor:ktor-client-java:$ktor_version")
    ```

    To use the Agent Studio client, add this import to your files:

    ```kt Kotlin icon=code theme={"system"}
    import com.algolia.client.api.AgentStudioClient
    import com.algolia.client.configuration.*
    import com.algolia.client.transport.*
    ```

    To create an instance of the client:

    ```kt Kotlin icon=code theme={"system"}
    val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
    ```
  </Tab>

  <Tab title="PHP">
    The Agent Studio API client is part of the `algoliasearch-client-php` package.
    To install this package, run:

    ```sh Command line icon=square-terminal theme={"system"}
    composer require algolia/algoliasearch-client-php
    ```

    To use the Agent Studio client, add this import to your files:

    ```php PHP icon=code theme={"system"}
    use Algolia\AlgoliaSearch\Api\AgentStudioClient;
    ```

    To create an instance of the client:

    ```php PHP icon=code theme={"system"}
    $client = AgentStudioClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
    ```
  </Tab>

  <Tab title="Python">
    The Agent Studio API client is part of the `algoliasearch` package.
    You can install this package with `pip`:

    ```sh Command line icon=square-terminal theme={"system"}
    pip install 'algoliasearch>=4,<5'
    ```

    To use the Agent Studio client, add this import to your files:

    ```python Python icon=code theme={"system"}
    from algoliasearch.agent_studio.client import AgentStudioClientSync
    from json import loads
    ```

    To create an instance of the client:

    ```python Python icon=code theme={"system"}
    # In an asynchronous context, you can use AgentStudioClient instead, which exposes the exact same methods.
    client = AgentStudioClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
    ```

    ## Async code

    To use the Agent Studio client in **async** environments,
    add these imports instead:

    ```python Python icon=code theme={"system"}
    import asyncio
    from algoliasearch.agent_studio.client import AgentStudioClient
    ```

    The client supports the [`async with`](https://peps.python.org/pep-0492/#asynchronous-context-managers-and-async-with) statement to automatically close open connections.

    ```python Python icon=code theme={"system"}
    async def run():
        async with AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY") as client:
            # client.create_agent_completion(...)
    ```

    The method names are the same for synchronous and asynchronous methods.
  </Tab>

  <Tab title="Ruby">
    The Agent Studio API client is part of the `algolia` gem.
    To install this gem, run:

    ```sh Command line icon=square-terminal theme={"system"}
    gem install algolia
    ```

    To use the Agent Studio client, add this import to your files:

    ```ruby Ruby icon=code theme={"system"}
    require "algolia"
    ```

    To create an instance of the client:

    ```ruby Ruby icon=code theme={"system"}
    client = Algolia::AgentStudioClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
    ```
  </Tab>

  <Tab title="Scala">
    The Agent Studio API client is part of the `algoliasearch-scala` package.
    You can add this package to your `build.sbt` file:

    ```txt build.sbt icon=braces theme={"system"}
    // For Scala 3:
    libraryDependencies += "com.algolia" %% "algoliasearch-scala_3" % "2.27.0"
    // For Scala 2:
    libraryDependencies += "com.algolia" %% "algoliasearch-scala_2" % "2.27.0"
    ```

    To use the Agent Studio client, add these imports to your files:

    ```scala Scala icon=code theme={"system"}
    import algoliasearch.api.AgentStudioClient
    import algoliasearch.config.*
    ```

    To create an instance of the client:

    ```scala Scala icon=code theme={"system"}
    val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
    ```
  </Tab>

  <Tab title="Swift">
    The Agent Studio API client is part of the `algoliasearch-client-swift` package.
    You can add this package to your `Package.swift` file:

    ```swift Package.swift icon=braces theme={"system"}
    // swift-tools-version: 5.10
    // The swift-tools-version declares the minimum version of Swift required to build this package.

    import PackageDescription

    let package = Package(
      name: "Algolia API clients",
      platforms: [
        .macOS(.v11)
      ],
      dependencies: [
        .package(
          url: "https://github.com/algolia/algoliasearch-client-swift.git", from: "9.28.0")
      ],
      targets: [
        .executableTarget(
          name: "Algolia API clients",
          dependencies: [
            .product(name: "AgentStudio", package: "algoliasearch-client-swift")
          ]
        )
      ]
    )
    ```

    To use the Agent Studio client, add this import to your files:

    ```swift Swift icon=code theme={"system"}
    import AgentStudio
    ```

    To create an instance of the client:

    ```swift Swift icon=code theme={"system"}
    let client = try AgentStudioClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
    ```
  </Tab>
</Tabs>

## Streaming

The Agent Studio API client supports streaming completions in **JavaScript** and **Python**.
Other languages only support non-streaming completions for now.

For more information, see [Create Completion](/doc/libraries/sdk/methods/agent-studio/create-agent-completion).

## Helper methods

The Agent Studio API client includes helper methods to simplify common tasks.

<Note>
  Not all helper methods are available for all API clients and their implementation might differ.
</Note>

* [Forge secured user token](/doc/libraries/sdk/methods/agent-studio/forge-secured-user-token)