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

# Patch Secret Key

> Patch Secret Key.

<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>

**Requires Admin API key**

## Usage

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

  // Call the API
  var response = await client.UpdateSecretKeyAsync(
    "a1b2c3d4-5678-90ab-cdef-123456789abc",
    new SecretKeyPatch
    {
      Name = "renamed-key",
      AgentIds = new List<string> { "76710f1b-8231-42e5-b0d1-f43aac618e15" },
    }
  );

  // print the response
  Console.WriteLine(response);
  ```

  ```dart Dart theme={"system"}
  // Initialize the client
  final client = AgentStudioClient(
      appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');

  // Call the API
  final response = await client.updateSecretKey(
    secretKeyId: "a1b2c3d4-5678-90ab-cdef-123456789abc",
    secretKeyPatch: SecretKeyPatch(
      name: "renamed-key",
      agentIds: [
        "76710f1b-8231-42e5-b0d1-f43aac618e15",
      ],
    ),
  );

  // print the response
  print(response);
  ```

  ```go Go theme={"system"}
  // Initialize the client
  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)
  }

  // Call the API
  response, err := client.UpdateSecretKey(client.NewApiUpdateSecretKeyRequest(
    "a1b2c3d4-5678-90ab-cdef-123456789abc",
    agentStudio.NewEmptySecretKeyPatch().SetName("renamed-key").SetAgentIds(
      []string{"76710f1b-8231-42e5-b0d1-f43aac618e15"})))
  if err != nil {
    // handle the eventual error
    panic(err)
  }


  // print the response
  print(response)
  ```

  ```java Java theme={"system"}
  // Initialize the client
  AgentStudioClient client = new AgentStudioClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");

  // Call the API
  SecretKeyResponse response = client.updateSecretKey(
    "a1b2c3d4-5678-90ab-cdef-123456789abc",
    new SecretKeyPatch().setName("renamed-key").setAgentIds(Arrays.asList("76710f1b-8231-42e5-b0d1-f43aac618e15"))
  );

  // print the response
  System.out.println(response);
  ```

  ```js JavaScript theme={"system"}
  // Initialize the client
  const client = agentStudioClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

  // Call the API
  const response = await client.updateSecretKey({
    secretKeyId: 'a1b2c3d4-5678-90ab-cdef-123456789abc',
    secretKeyPatch: { name: 'renamed-key', agentIds: ['76710f1b-8231-42e5-b0d1-f43aac618e15'] },
  });


  // print the response
  console.log(response);
  ```

  ```kotlin Kotlin theme={"system"}
  // Initialize the client
  val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

  // Call the API
  var response =
    client.updateSecretKey(
      secretKeyId = "a1b2c3d4-5678-90ab-cdef-123456789abc",
      secretKeyPatch =
        SecretKeyPatch(
          name = "renamed-key",
          agentIds = listOf("76710f1b-8231-42e5-b0d1-f43aac618e15"),
        ),
    )


  // print the response
  println(response)
  ```

  ```php PHP theme={"system"}
  // Initialize the client
  $client = AgentStudioClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');

  // Call the API
  $response = $client->updateSecretKey(
      'a1b2c3d4-5678-90ab-cdef-123456789abc',
      ['name' => 'renamed-key',
          'agentIds' => [
              '76710f1b-8231-42e5-b0d1-f43aac618e15',
          ],
      ],
  );


  // print the response
  var_dump($response);
  ```

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

  # Call the API
  response = client.update_secret_key(
      secret_key_id="a1b2c3d4-5678-90ab-cdef-123456789abc",
      secret_key_patch={
          "name": "renamed-key",
          "agentIds": [
              "76710f1b-8231-42e5-b0d1-f43aac618e15",
          ],
      },
  )


  # print the response
  print(response)
  ```

  ```ruby Ruby theme={"system"}
  # Initialize the client
  client = Algolia::AgentStudioClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")

  # Call the API
  response = client.update_secret_key(
    "a1b2c3d4-5678-90ab-cdef-123456789abc",
    Algolia::AgentStudio::SecretKeyPatch.new(name: "renamed-key", agent_ids: ["76710f1b-8231-42e5-b0d1-f43aac618e15"])
  )


  # print the response
  puts(response)
  ```

  ```scala Scala theme={"system"}
  // Initialize the client
  val client = AgentStudioClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")

  // Call the API
  val response = Await.result(
    client.updateSecretKey(
      secretKeyId = "a1b2c3d4-5678-90ab-cdef-123456789abc",
      secretKeyPatch = SecretKeyPatch(
        name = Some("renamed-key"),
        agentIds = Some(Seq("76710f1b-8231-42e5-b0d1-f43aac618e15"))
      )
    ),
    Duration(100, "sec")
  )

  // print the response
  println(response)
  ```

  ```swift Swift theme={"system"}
  // Initialize the client
  let client = try AgentStudioClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")

  // Call the API
  let response = try await client.updateSecretKey(
      secretKeyId: "a1b2c3d4-5678-90ab-cdef-123456789abc",
      secretKeyPatch: SecretKeyPatch(name: "renamed-key", agentIds: ["76710f1b-8231-42e5-b0d1-f43aac618e15"])
  )

  // print the response
  print(response)
  ```
</CodeGroup>

<Card icon="folder-code" horizontal="true" title="See the full API reference" arrow="true" href="/doc/rest-api/agent-studio/update-secret-key">
  For more details about input parameters
  and response fields.
</Card>